@aws-sdk/client-qconnect 3.665.0 → 3.667.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/README.md +166 -0
- package/dist-cjs/index.js +1501 -102
- package/dist-es/QConnect.js +38 -0
- package/dist-es/commands/CreateAIAgentCommand.js +22 -0
- package/dist-es/commands/CreateAIAgentVersionCommand.js +22 -0
- package/dist-es/commands/CreateAIPromptCommand.js +23 -0
- package/dist-es/commands/CreateAIPromptVersionCommand.js +23 -0
- package/dist-es/commands/CreateKnowledgeBaseCommand.js +2 -1
- package/dist-es/commands/DeleteAIAgentCommand.js +22 -0
- package/dist-es/commands/DeleteAIAgentVersionCommand.js +22 -0
- package/dist-es/commands/DeleteAIPromptCommand.js +22 -0
- package/dist-es/commands/DeleteAIPromptVersionCommand.js +22 -0
- package/dist-es/commands/GetAIAgentCommand.js +22 -0
- package/dist-es/commands/GetAIPromptCommand.js +23 -0
- package/dist-es/commands/GetKnowledgeBaseCommand.js +2 -1
- package/dist-es/commands/ListAIAgentVersionsCommand.js +22 -0
- package/dist-es/commands/ListAIAgentsCommand.js +22 -0
- package/dist-es/commands/ListAIPromptVersionsCommand.js +22 -0
- package/dist-es/commands/ListAIPromptsCommand.js +22 -0
- package/dist-es/commands/ListKnowledgeBasesCommand.js +2 -1
- package/dist-es/commands/RemoveAssistantAIAgentCommand.js +22 -0
- package/dist-es/commands/UpdateAIAgentCommand.js +22 -0
- package/dist-es/commands/UpdateAIPromptCommand.js +23 -0
- package/dist-es/commands/UpdateAssistantAIAgentCommand.js +22 -0
- package/dist-es/commands/UpdateKnowledgeBaseTemplateUriCommand.js +2 -1
- package/dist-es/commands/UpdateSessionDataCommand.js +23 -0
- package/dist-es/commands/index.js +19 -0
- package/dist-es/models/models_0.js +310 -46
- package/dist-es/pagination/ListAIAgentVersionsPaginator.js +4 -0
- package/dist-es/pagination/ListAIAgentsPaginator.js +4 -0
- package/dist-es/pagination/ListAIPromptVersionsPaginator.js +4 -0
- package/dist-es/pagination/ListAIPromptsPaginator.js +4 -0
- package/dist-es/pagination/index.js +4 -0
- package/dist-es/protocols/Aws_restJson1.js +692 -8
- package/dist-types/QConnect.d.ts +148 -1
- package/dist-types/QConnectClient.d.ts +36 -3
- package/dist-types/commands/CreateAIAgentCommand.d.ts +252 -0
- package/dist-types/commands/CreateAIAgentVersionCommand.d.ts +180 -0
- package/dist-types/commands/CreateAIPromptCommand.d.ts +132 -0
- package/dist-types/commands/CreateAIPromptVersionCommand.d.ts +120 -0
- package/dist-types/commands/CreateAssistantCommand.d.ts +5 -0
- package/dist-types/commands/CreateContentAssociationCommand.d.ts +5 -6
- package/dist-types/commands/CreateKnowledgeBaseCommand.d.ts +108 -0
- package/dist-types/commands/CreateSessionCommand.d.ts +10 -0
- package/dist-types/commands/DeleteAIAgentCommand.d.ts +82 -0
- package/dist-types/commands/DeleteAIAgentVersionCommand.d.ts +89 -0
- package/dist-types/commands/DeleteAIPromptCommand.d.ts +82 -0
- package/dist-types/commands/DeleteAIPromptVersionCommand.d.ts +89 -0
- package/dist-types/commands/GetAIAgentCommand.d.ts +168 -0
- package/dist-types/commands/GetAIPromptCommand.d.ts +108 -0
- package/dist-types/commands/GetAssistantCommand.d.ts +5 -0
- package/dist-types/commands/GetKnowledgeBaseCommand.d.ts +56 -0
- package/dist-types/commands/GetRecommendationsCommand.d.ts +20 -0
- package/dist-types/commands/GetSessionCommand.d.ts +5 -0
- package/dist-types/commands/ListAIAgentVersionsCommand.d.ts +176 -0
- package/dist-types/commands/ListAIAgentsCommand.d.ts +172 -0
- package/dist-types/commands/ListAIPromptVersionsCommand.d.ts +111 -0
- package/dist-types/commands/ListAIPromptsCommand.d.ts +107 -0
- package/dist-types/commands/ListAssistantsCommand.d.ts +5 -0
- package/dist-types/commands/ListKnowledgeBasesCommand.d.ts +52 -0
- package/dist-types/commands/QueryAssistantCommand.d.ts +30 -1
- package/dist-types/commands/RemoveAssistantAIAgentCommand.d.ts +83 -0
- package/dist-types/commands/UpdateAIAgentCommand.d.ts +244 -0
- package/dist-types/commands/UpdateAIPromptCommand.d.ts +121 -0
- package/dist-types/commands/UpdateAssistantAIAgentCommand.d.ts +112 -0
- package/dist-types/commands/UpdateKnowledgeBaseTemplateUriCommand.d.ts +56 -0
- package/dist-types/commands/UpdateSessionCommand.d.ts +10 -0
- package/dist-types/commands/UpdateSessionDataCommand.d.ts +100 -0
- package/dist-types/commands/index.d.ts +19 -0
- package/dist-types/index.d.ts +15 -1
- package/dist-types/models/models_0.d.ts +2454 -275
- package/dist-types/pagination/ListAIAgentVersionsPaginator.d.ts +7 -0
- package/dist-types/pagination/ListAIAgentsPaginator.d.ts +7 -0
- package/dist-types/pagination/ListAIPromptVersionsPaginator.d.ts +7 -0
- package/dist-types/pagination/ListAIPromptsPaginator.d.ts +7 -0
- package/dist-types/pagination/index.d.ts +4 -0
- package/dist-types/protocols/Aws_restJson1.d.ts +171 -0
- package/dist-types/ts3.4/QConnect.d.ts +323 -0
- package/dist-types/ts3.4/QConnectClient.d.ts +116 -2
- package/dist-types/ts3.4/commands/CreateAIAgentCommand.d.ts +50 -0
- package/dist-types/ts3.4/commands/CreateAIAgentVersionCommand.d.ts +51 -0
- package/dist-types/ts3.4/commands/CreateAIPromptCommand.d.ts +50 -0
- package/dist-types/ts3.4/commands/CreateAIPromptVersionCommand.d.ts +51 -0
- package/dist-types/ts3.4/commands/DeleteAIAgentCommand.d.ts +50 -0
- package/dist-types/ts3.4/commands/DeleteAIAgentVersionCommand.d.ts +51 -0
- package/dist-types/ts3.4/commands/DeleteAIPromptCommand.d.ts +50 -0
- package/dist-types/ts3.4/commands/DeleteAIPromptVersionCommand.d.ts +51 -0
- package/dist-types/ts3.4/commands/GetAIAgentCommand.d.ts +47 -0
- package/dist-types/ts3.4/commands/GetAIPromptCommand.d.ts +47 -0
- package/dist-types/ts3.4/commands/ListAIAgentVersionsCommand.d.ts +51 -0
- package/dist-types/ts3.4/commands/ListAIAgentsCommand.d.ts +47 -0
- package/dist-types/ts3.4/commands/ListAIPromptVersionsCommand.d.ts +51 -0
- package/dist-types/ts3.4/commands/ListAIPromptsCommand.d.ts +50 -0
- package/dist-types/ts3.4/commands/RemoveAssistantAIAgentCommand.d.ts +51 -0
- package/dist-types/ts3.4/commands/UpdateAIAgentCommand.d.ts +50 -0
- package/dist-types/ts3.4/commands/UpdateAIPromptCommand.d.ts +50 -0
- package/dist-types/ts3.4/commands/UpdateAssistantAIAgentCommand.d.ts +51 -0
- package/dist-types/ts3.4/commands/UpdateSessionDataCommand.d.ts +51 -0
- package/dist-types/ts3.4/commands/index.d.ts +19 -0
- package/dist-types/ts3.4/models/models_0.d.ts +794 -103
- package/dist-types/ts3.4/pagination/ListAIAgentVersionsPaginator.d.ts +11 -0
- package/dist-types/ts3.4/pagination/ListAIAgentsPaginator.d.ts +11 -0
- package/dist-types/ts3.4/pagination/ListAIPromptVersionsPaginator.d.ts +11 -0
- package/dist-types/ts3.4/pagination/ListAIPromptsPaginator.d.ts +11 -0
- package/dist-types/ts3.4/pagination/index.d.ts +4 -0
- package/dist-types/ts3.4/protocols/Aws_restJson1.d.ts +228 -0
- package/package.json +19 -19
|
@@ -47,6 +47,37 @@ declare const GetKnowledgeBaseCommand_base: {
|
|
|
47
47
|
* // knowledgeBaseType: "STRING_VALUE", // required
|
|
48
48
|
* // status: "STRING_VALUE", // required
|
|
49
49
|
* // lastContentModificationTime: new Date("TIMESTAMP"),
|
|
50
|
+
* // vectorIngestionConfiguration: { // VectorIngestionConfiguration
|
|
51
|
+
* // chunkingConfiguration: { // ChunkingConfiguration
|
|
52
|
+
* // chunkingStrategy: "STRING_VALUE", // required
|
|
53
|
+
* // fixedSizeChunkingConfiguration: { // FixedSizeChunkingConfiguration
|
|
54
|
+
* // maxTokens: Number("int"), // required
|
|
55
|
+
* // overlapPercentage: Number("int"), // required
|
|
56
|
+
* // },
|
|
57
|
+
* // hierarchicalChunkingConfiguration: { // HierarchicalChunkingConfiguration
|
|
58
|
+
* // levelConfigurations: [ // HierarchicalChunkingLevelConfigurations // required
|
|
59
|
+
* // { // HierarchicalChunkingLevelConfiguration
|
|
60
|
+
* // maxTokens: Number("int"), // required
|
|
61
|
+
* // },
|
|
62
|
+
* // ],
|
|
63
|
+
* // overlapTokens: Number("int"), // required
|
|
64
|
+
* // },
|
|
65
|
+
* // semanticChunkingConfiguration: { // SemanticChunkingConfiguration
|
|
66
|
+
* // maxTokens: Number("int"), // required
|
|
67
|
+
* // bufferSize: Number("int"), // required
|
|
68
|
+
* // breakpointPercentileThreshold: Number("int"), // required
|
|
69
|
+
* // },
|
|
70
|
+
* // },
|
|
71
|
+
* // parsingConfiguration: { // ParsingConfiguration
|
|
72
|
+
* // parsingStrategy: "STRING_VALUE", // required
|
|
73
|
+
* // bedrockFoundationModelConfiguration: { // BedrockFoundationModelConfigurationForParsing
|
|
74
|
+
* // modelArn: "STRING_VALUE", // required
|
|
75
|
+
* // parsingPrompt: { // ParsingPrompt
|
|
76
|
+
* // parsingPromptText: "STRING_VALUE", // required
|
|
77
|
+
* // },
|
|
78
|
+
* // },
|
|
79
|
+
* // },
|
|
80
|
+
* // },
|
|
50
81
|
* // sourceConfiguration: { // SourceConfiguration Union: only one key present
|
|
51
82
|
* // appIntegrations: { // AppIntegrationsConfiguration
|
|
52
83
|
* // appIntegrationArn: "STRING_VALUE", // required
|
|
@@ -54,6 +85,27 @@ declare const GetKnowledgeBaseCommand_base: {
|
|
|
54
85
|
* // "STRING_VALUE",
|
|
55
86
|
* // ],
|
|
56
87
|
* // },
|
|
88
|
+
* // managedSourceConfiguration: { // ManagedSourceConfiguration Union: only one key present
|
|
89
|
+
* // webCrawlerConfiguration: { // WebCrawlerConfiguration
|
|
90
|
+
* // urlConfiguration: { // UrlConfiguration
|
|
91
|
+
* // seedUrls: [ // SeedUrls
|
|
92
|
+
* // { // SeedUrl
|
|
93
|
+
* // url: "STRING_VALUE",
|
|
94
|
+
* // },
|
|
95
|
+
* // ],
|
|
96
|
+
* // },
|
|
97
|
+
* // crawlerLimits: { // WebCrawlerLimits
|
|
98
|
+
* // rateLimit: Number("int"),
|
|
99
|
+
* // },
|
|
100
|
+
* // inclusionFilters: [ // UrlFilterList
|
|
101
|
+
* // "STRING_VALUE",
|
|
102
|
+
* // ],
|
|
103
|
+
* // exclusionFilters: [
|
|
104
|
+
* // "STRING_VALUE",
|
|
105
|
+
* // ],
|
|
106
|
+
* // scope: "STRING_VALUE",
|
|
107
|
+
* // },
|
|
108
|
+
* // },
|
|
57
109
|
* // },
|
|
58
110
|
* // renderingConfiguration: { // RenderingConfiguration
|
|
59
111
|
* // templateUri: "STRING_VALUE",
|
|
@@ -65,6 +117,10 @@ declare const GetKnowledgeBaseCommand_base: {
|
|
|
65
117
|
* // tags: { // Tags
|
|
66
118
|
* // "<keys>": "STRING_VALUE",
|
|
67
119
|
* // },
|
|
120
|
+
* // ingestionStatus: "STRING_VALUE",
|
|
121
|
+
* // ingestionFailureReasons: [ // FailureReason
|
|
122
|
+
* // "STRING_VALUE",
|
|
123
|
+
* // ],
|
|
68
124
|
* // },
|
|
69
125
|
* // };
|
|
70
126
|
*
|
|
@@ -63,6 +63,8 @@ declare const GetRecommendationsCommand_base: {
|
|
|
63
63
|
* // knowledgeBaseId: "STRING_VALUE",
|
|
64
64
|
* // contentArn: "STRING_VALUE",
|
|
65
65
|
* // contentId: "STRING_VALUE",
|
|
66
|
+
* // sourceURL: "STRING_VALUE",
|
|
67
|
+
* // referenceType: "STRING_VALUE",
|
|
66
68
|
* // },
|
|
67
69
|
* // title: { // DocumentText
|
|
68
70
|
* // text: "STRING_VALUE",
|
|
@@ -93,6 +95,8 @@ declare const GetRecommendationsCommand_base: {
|
|
|
93
95
|
* // knowledgeBaseId: "STRING_VALUE",
|
|
94
96
|
* // contentArn: "STRING_VALUE",
|
|
95
97
|
* // contentId: "STRING_VALUE",
|
|
98
|
+
* // sourceURL: "STRING_VALUE",
|
|
99
|
+
* // referenceType: "STRING_VALUE",
|
|
96
100
|
* // },
|
|
97
101
|
* // generativeReference: { // GenerativeReference
|
|
98
102
|
* // modelId: "STRING_VALUE",
|
|
@@ -158,6 +162,10 @@ declare const GetRecommendationsCommand_base: {
|
|
|
158
162
|
* // relevanceLevel: "STRING_VALUE",
|
|
159
163
|
* // },
|
|
160
164
|
* // },
|
|
165
|
+
* // intentDetectedData: { // IntentDetectedDataDetails
|
|
166
|
+
* // intent: "STRING_VALUE", // required
|
|
167
|
+
* // intentId: "STRING_VALUE", // required
|
|
168
|
+
* // },
|
|
161
169
|
* // sourceContentData: { // SourceContentDataDetails
|
|
162
170
|
* // id: "STRING_VALUE", // required
|
|
163
171
|
* // type: "STRING_VALUE", // required
|
|
@@ -169,6 +177,10 @@ declare const GetRecommendationsCommand_base: {
|
|
|
169
177
|
* // relevanceScore: Number("double"),
|
|
170
178
|
* // relevanceLevel: "STRING_VALUE",
|
|
171
179
|
* // },
|
|
180
|
+
* // citationSpan: { // CitationSpan
|
|
181
|
+
* // beginOffsetInclusive: Number("int"),
|
|
182
|
+
* // endOffsetExclusive: Number("int"),
|
|
183
|
+
* // },
|
|
172
184
|
* // },
|
|
173
185
|
* // },
|
|
174
186
|
* // },
|
|
@@ -178,6 +190,10 @@ declare const GetRecommendationsCommand_base: {
|
|
|
178
190
|
* // relevanceLevel: "STRING_VALUE",
|
|
179
191
|
* // },
|
|
180
192
|
* // },
|
|
193
|
+
* // intentDetectedData: {
|
|
194
|
+
* // intent: "STRING_VALUE", // required
|
|
195
|
+
* // intentId: "STRING_VALUE", // required
|
|
196
|
+
* // },
|
|
181
197
|
* // sourceContentData: {
|
|
182
198
|
* // id: "STRING_VALUE", // required
|
|
183
199
|
* // type: "STRING_VALUE", // required
|
|
@@ -186,6 +202,10 @@ declare const GetRecommendationsCommand_base: {
|
|
|
186
202
|
* // excerpt: "<DocumentText>",
|
|
187
203
|
* // },
|
|
188
204
|
* // rankingData: "<RankingData>", // required
|
|
205
|
+
* // citationSpan: {
|
|
206
|
+
* // beginOffsetInclusive: Number("int"),
|
|
207
|
+
* // endOffsetExclusive: Number("int"),
|
|
208
|
+
* // },
|
|
189
209
|
* // },
|
|
190
210
|
* // },
|
|
191
211
|
* // },
|
|
@@ -72,6 +72,11 @@ declare const GetSessionCommand_base: {
|
|
|
72
72
|
* // },
|
|
73
73
|
* // ],
|
|
74
74
|
* // },
|
|
75
|
+
* // aiAgentConfiguration: { // AIAgentConfigurationMap
|
|
76
|
+
* // "<keys>": { // AIAgentConfigurationData
|
|
77
|
+
* // aiAgentId: "STRING_VALUE", // required
|
|
78
|
+
* // },
|
|
79
|
+
* // },
|
|
75
80
|
* // },
|
|
76
81
|
* // };
|
|
77
82
|
*
|
|
@@ -0,0 +1,176 @@
|
|
|
1
|
+
import { Command as $Command } from "@smithy/smithy-client";
|
|
2
|
+
import { MetadataBearer as __MetadataBearer } from "@smithy/types";
|
|
3
|
+
import { ListAIAgentVersionsRequest, ListAIAgentVersionsResponse } from "../models/models_0";
|
|
4
|
+
import { QConnectClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../QConnectClient";
|
|
5
|
+
/**
|
|
6
|
+
* @public
|
|
7
|
+
*/
|
|
8
|
+
export type { __MetadataBearer };
|
|
9
|
+
export { $Command };
|
|
10
|
+
/**
|
|
11
|
+
* @public
|
|
12
|
+
*
|
|
13
|
+
* The input for {@link ListAIAgentVersionsCommand}.
|
|
14
|
+
*/
|
|
15
|
+
export interface ListAIAgentVersionsCommandInput extends ListAIAgentVersionsRequest {
|
|
16
|
+
}
|
|
17
|
+
/**
|
|
18
|
+
* @public
|
|
19
|
+
*
|
|
20
|
+
* The output of {@link ListAIAgentVersionsCommand}.
|
|
21
|
+
*/
|
|
22
|
+
export interface ListAIAgentVersionsCommandOutput extends ListAIAgentVersionsResponse, __MetadataBearer {
|
|
23
|
+
}
|
|
24
|
+
declare const ListAIAgentVersionsCommand_base: {
|
|
25
|
+
new (input: ListAIAgentVersionsCommandInput): import("@smithy/smithy-client").CommandImpl<ListAIAgentVersionsCommandInput, ListAIAgentVersionsCommandOutput, QConnectClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
26
|
+
new (__0_0: ListAIAgentVersionsCommandInput): import("@smithy/smithy-client").CommandImpl<ListAIAgentVersionsCommandInput, ListAIAgentVersionsCommandOutput, QConnectClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
27
|
+
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
|
+
};
|
|
29
|
+
/**
|
|
30
|
+
* <p>List AI Agent versions.</p>
|
|
31
|
+
* @example
|
|
32
|
+
* Use a bare-bones client and the command you need to make an API call.
|
|
33
|
+
* ```javascript
|
|
34
|
+
* import { QConnectClient, ListAIAgentVersionsCommand } from "@aws-sdk/client-qconnect"; // ES Modules import
|
|
35
|
+
* // const { QConnectClient, ListAIAgentVersionsCommand } = require("@aws-sdk/client-qconnect"); // CommonJS import
|
|
36
|
+
* const client = new QConnectClient(config);
|
|
37
|
+
* const input = { // ListAIAgentVersionsRequest
|
|
38
|
+
* assistantId: "STRING_VALUE", // required
|
|
39
|
+
* aiAgentId: "STRING_VALUE", // required
|
|
40
|
+
* nextToken: "STRING_VALUE",
|
|
41
|
+
* maxResults: Number("int"),
|
|
42
|
+
* origin: "STRING_VALUE",
|
|
43
|
+
* };
|
|
44
|
+
* const command = new ListAIAgentVersionsCommand(input);
|
|
45
|
+
* const response = await client.send(command);
|
|
46
|
+
* // { // ListAIAgentVersionsResponse
|
|
47
|
+
* // aiAgentVersionSummaries: [ // AIAgentVersionSummariesList // required
|
|
48
|
+
* // { // AIAgentVersionSummary
|
|
49
|
+
* // aiAgentSummary: { // AIAgentSummary
|
|
50
|
+
* // name: "STRING_VALUE", // required
|
|
51
|
+
* // assistantId: "STRING_VALUE", // required
|
|
52
|
+
* // assistantArn: "STRING_VALUE", // required
|
|
53
|
+
* // aiAgentId: "STRING_VALUE", // required
|
|
54
|
+
* // type: "STRING_VALUE", // required
|
|
55
|
+
* // aiAgentArn: "STRING_VALUE", // required
|
|
56
|
+
* // modifiedTime: new Date("TIMESTAMP"),
|
|
57
|
+
* // visibilityStatus: "STRING_VALUE", // required
|
|
58
|
+
* // configuration: { // AIAgentConfiguration Union: only one key present
|
|
59
|
+
* // manualSearchAIAgentConfiguration: { // ManualSearchAIAgentConfiguration
|
|
60
|
+
* // answerGenerationAIPromptId: "STRING_VALUE",
|
|
61
|
+
* // associationConfigurations: [ // AssociationConfigurationList
|
|
62
|
+
* // { // AssociationConfiguration
|
|
63
|
+
* // associationId: "STRING_VALUE",
|
|
64
|
+
* // associationType: "STRING_VALUE",
|
|
65
|
+
* // associationConfigurationData: { // AssociationConfigurationData Union: only one key present
|
|
66
|
+
* // knowledgeBaseAssociationConfigurationData: { // KnowledgeBaseAssociationConfigurationData
|
|
67
|
+
* // contentTagFilter: { // TagFilter Union: only one key present
|
|
68
|
+
* // tagCondition: { // TagCondition
|
|
69
|
+
* // key: "STRING_VALUE", // required
|
|
70
|
+
* // value: "STRING_VALUE",
|
|
71
|
+
* // },
|
|
72
|
+
* // andConditions: [ // AndConditions
|
|
73
|
+
* // {
|
|
74
|
+
* // key: "STRING_VALUE", // required
|
|
75
|
+
* // value: "STRING_VALUE",
|
|
76
|
+
* // },
|
|
77
|
+
* // ],
|
|
78
|
+
* // orConditions: [ // OrConditions
|
|
79
|
+
* // { // OrCondition Union: only one key present
|
|
80
|
+
* // andConditions: [
|
|
81
|
+
* // "<TagCondition>",
|
|
82
|
+
* // ],
|
|
83
|
+
* // tagCondition: "<TagCondition>",
|
|
84
|
+
* // },
|
|
85
|
+
* // ],
|
|
86
|
+
* // },
|
|
87
|
+
* // maxResults: Number("int"),
|
|
88
|
+
* // overrideKnowledgeBaseSearchType: "STRING_VALUE",
|
|
89
|
+
* // },
|
|
90
|
+
* // },
|
|
91
|
+
* // },
|
|
92
|
+
* // ],
|
|
93
|
+
* // },
|
|
94
|
+
* // answerRecommendationAIAgentConfiguration: { // AnswerRecommendationAIAgentConfiguration
|
|
95
|
+
* // intentLabelingGenerationAIPromptId: "STRING_VALUE",
|
|
96
|
+
* // queryReformulationAIPromptId: "STRING_VALUE",
|
|
97
|
+
* // answerGenerationAIPromptId: "STRING_VALUE",
|
|
98
|
+
* // associationConfigurations: [
|
|
99
|
+
* // {
|
|
100
|
+
* // associationId: "STRING_VALUE",
|
|
101
|
+
* // associationType: "STRING_VALUE",
|
|
102
|
+
* // associationConfigurationData: {// Union: only one key present
|
|
103
|
+
* // knowledgeBaseAssociationConfigurationData: {
|
|
104
|
+
* // contentTagFilter: {// Union: only one key present
|
|
105
|
+
* // tagCondition: "<TagCondition>",
|
|
106
|
+
* // andConditions: [
|
|
107
|
+
* // "<TagCondition>",
|
|
108
|
+
* // ],
|
|
109
|
+
* // orConditions: [
|
|
110
|
+
* // {// Union: only one key present
|
|
111
|
+
* // andConditions: [
|
|
112
|
+
* // "<TagCondition>",
|
|
113
|
+
* // ],
|
|
114
|
+
* // tagCondition: "<TagCondition>",
|
|
115
|
+
* // },
|
|
116
|
+
* // ],
|
|
117
|
+
* // },
|
|
118
|
+
* // maxResults: Number("int"),
|
|
119
|
+
* // overrideKnowledgeBaseSearchType: "STRING_VALUE",
|
|
120
|
+
* // },
|
|
121
|
+
* // },
|
|
122
|
+
* // },
|
|
123
|
+
* // ],
|
|
124
|
+
* // },
|
|
125
|
+
* // },
|
|
126
|
+
* // origin: "STRING_VALUE",
|
|
127
|
+
* // description: "STRING_VALUE",
|
|
128
|
+
* // status: "STRING_VALUE",
|
|
129
|
+
* // tags: { // Tags
|
|
130
|
+
* // "<keys>": "STRING_VALUE",
|
|
131
|
+
* // },
|
|
132
|
+
* // },
|
|
133
|
+
* // versionNumber: Number("long"),
|
|
134
|
+
* // },
|
|
135
|
+
* // ],
|
|
136
|
+
* // nextToken: "STRING_VALUE",
|
|
137
|
+
* // };
|
|
138
|
+
*
|
|
139
|
+
* ```
|
|
140
|
+
*
|
|
141
|
+
* @param ListAIAgentVersionsCommandInput - {@link ListAIAgentVersionsCommandInput}
|
|
142
|
+
* @returns {@link ListAIAgentVersionsCommandOutput}
|
|
143
|
+
* @see {@link ListAIAgentVersionsCommandInput} for command's `input` shape.
|
|
144
|
+
* @see {@link ListAIAgentVersionsCommandOutput} for command's `response` shape.
|
|
145
|
+
* @see {@link QConnectClientResolvedConfig | config} for QConnectClient's `config` shape.
|
|
146
|
+
*
|
|
147
|
+
* @throws {@link AccessDeniedException} (client fault)
|
|
148
|
+
* <p>You do not have sufficient access to perform this action.</p>
|
|
149
|
+
*
|
|
150
|
+
* @throws {@link ResourceNotFoundException} (client fault)
|
|
151
|
+
* <p>The specified resource does not exist.</p>
|
|
152
|
+
*
|
|
153
|
+
* @throws {@link ThrottlingException} (client fault)
|
|
154
|
+
* <p>The throttling limit has been exceeded.</p>
|
|
155
|
+
*
|
|
156
|
+
* @throws {@link ValidationException} (client fault)
|
|
157
|
+
* <p>The input fails to satisfy the constraints specified by a service.</p>
|
|
158
|
+
*
|
|
159
|
+
* @throws {@link QConnectServiceException}
|
|
160
|
+
* <p>Base exception class for all service exceptions from QConnect service.</p>
|
|
161
|
+
*
|
|
162
|
+
* @public
|
|
163
|
+
*/
|
|
164
|
+
export declare class ListAIAgentVersionsCommand extends ListAIAgentVersionsCommand_base {
|
|
165
|
+
/** @internal type navigation helper, not in runtime. */
|
|
166
|
+
protected static __types: {
|
|
167
|
+
api: {
|
|
168
|
+
input: ListAIAgentVersionsRequest;
|
|
169
|
+
output: ListAIAgentVersionsResponse;
|
|
170
|
+
};
|
|
171
|
+
sdk: {
|
|
172
|
+
input: ListAIAgentVersionsCommandInput;
|
|
173
|
+
output: ListAIAgentVersionsCommandOutput;
|
|
174
|
+
};
|
|
175
|
+
};
|
|
176
|
+
}
|
|
@@ -0,0 +1,172 @@
|
|
|
1
|
+
import { Command as $Command } from "@smithy/smithy-client";
|
|
2
|
+
import { MetadataBearer as __MetadataBearer } from "@smithy/types";
|
|
3
|
+
import { ListAIAgentsRequest, ListAIAgentsResponse } from "../models/models_0";
|
|
4
|
+
import { QConnectClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../QConnectClient";
|
|
5
|
+
/**
|
|
6
|
+
* @public
|
|
7
|
+
*/
|
|
8
|
+
export type { __MetadataBearer };
|
|
9
|
+
export { $Command };
|
|
10
|
+
/**
|
|
11
|
+
* @public
|
|
12
|
+
*
|
|
13
|
+
* The input for {@link ListAIAgentsCommand}.
|
|
14
|
+
*/
|
|
15
|
+
export interface ListAIAgentsCommandInput extends ListAIAgentsRequest {
|
|
16
|
+
}
|
|
17
|
+
/**
|
|
18
|
+
* @public
|
|
19
|
+
*
|
|
20
|
+
* The output of {@link ListAIAgentsCommand}.
|
|
21
|
+
*/
|
|
22
|
+
export interface ListAIAgentsCommandOutput extends ListAIAgentsResponse, __MetadataBearer {
|
|
23
|
+
}
|
|
24
|
+
declare const ListAIAgentsCommand_base: {
|
|
25
|
+
new (input: ListAIAgentsCommandInput): import("@smithy/smithy-client").CommandImpl<ListAIAgentsCommandInput, ListAIAgentsCommandOutput, QConnectClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
26
|
+
new (__0_0: ListAIAgentsCommandInput): import("@smithy/smithy-client").CommandImpl<ListAIAgentsCommandInput, ListAIAgentsCommandOutput, QConnectClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
27
|
+
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
|
+
};
|
|
29
|
+
/**
|
|
30
|
+
* <p>Lists AI Agents.</p>
|
|
31
|
+
* @example
|
|
32
|
+
* Use a bare-bones client and the command you need to make an API call.
|
|
33
|
+
* ```javascript
|
|
34
|
+
* import { QConnectClient, ListAIAgentsCommand } from "@aws-sdk/client-qconnect"; // ES Modules import
|
|
35
|
+
* // const { QConnectClient, ListAIAgentsCommand } = require("@aws-sdk/client-qconnect"); // CommonJS import
|
|
36
|
+
* const client = new QConnectClient(config);
|
|
37
|
+
* const input = { // ListAIAgentsRequest
|
|
38
|
+
* assistantId: "STRING_VALUE", // required
|
|
39
|
+
* nextToken: "STRING_VALUE",
|
|
40
|
+
* maxResults: Number("int"),
|
|
41
|
+
* origin: "STRING_VALUE",
|
|
42
|
+
* };
|
|
43
|
+
* const command = new ListAIAgentsCommand(input);
|
|
44
|
+
* const response = await client.send(command);
|
|
45
|
+
* // { // ListAIAgentsResponse
|
|
46
|
+
* // aiAgentSummaries: [ // AIAgentSummaryList // required
|
|
47
|
+
* // { // AIAgentSummary
|
|
48
|
+
* // name: "STRING_VALUE", // required
|
|
49
|
+
* // assistantId: "STRING_VALUE", // required
|
|
50
|
+
* // assistantArn: "STRING_VALUE", // required
|
|
51
|
+
* // aiAgentId: "STRING_VALUE", // required
|
|
52
|
+
* // type: "STRING_VALUE", // required
|
|
53
|
+
* // aiAgentArn: "STRING_VALUE", // required
|
|
54
|
+
* // modifiedTime: new Date("TIMESTAMP"),
|
|
55
|
+
* // visibilityStatus: "STRING_VALUE", // required
|
|
56
|
+
* // configuration: { // AIAgentConfiguration Union: only one key present
|
|
57
|
+
* // manualSearchAIAgentConfiguration: { // ManualSearchAIAgentConfiguration
|
|
58
|
+
* // answerGenerationAIPromptId: "STRING_VALUE",
|
|
59
|
+
* // associationConfigurations: [ // AssociationConfigurationList
|
|
60
|
+
* // { // AssociationConfiguration
|
|
61
|
+
* // associationId: "STRING_VALUE",
|
|
62
|
+
* // associationType: "STRING_VALUE",
|
|
63
|
+
* // associationConfigurationData: { // AssociationConfigurationData Union: only one key present
|
|
64
|
+
* // knowledgeBaseAssociationConfigurationData: { // KnowledgeBaseAssociationConfigurationData
|
|
65
|
+
* // contentTagFilter: { // TagFilter Union: only one key present
|
|
66
|
+
* // tagCondition: { // TagCondition
|
|
67
|
+
* // key: "STRING_VALUE", // required
|
|
68
|
+
* // value: "STRING_VALUE",
|
|
69
|
+
* // },
|
|
70
|
+
* // andConditions: [ // AndConditions
|
|
71
|
+
* // {
|
|
72
|
+
* // key: "STRING_VALUE", // required
|
|
73
|
+
* // value: "STRING_VALUE",
|
|
74
|
+
* // },
|
|
75
|
+
* // ],
|
|
76
|
+
* // orConditions: [ // OrConditions
|
|
77
|
+
* // { // OrCondition Union: only one key present
|
|
78
|
+
* // andConditions: [
|
|
79
|
+
* // "<TagCondition>",
|
|
80
|
+
* // ],
|
|
81
|
+
* // tagCondition: "<TagCondition>",
|
|
82
|
+
* // },
|
|
83
|
+
* // ],
|
|
84
|
+
* // },
|
|
85
|
+
* // maxResults: Number("int"),
|
|
86
|
+
* // overrideKnowledgeBaseSearchType: "STRING_VALUE",
|
|
87
|
+
* // },
|
|
88
|
+
* // },
|
|
89
|
+
* // },
|
|
90
|
+
* // ],
|
|
91
|
+
* // },
|
|
92
|
+
* // answerRecommendationAIAgentConfiguration: { // AnswerRecommendationAIAgentConfiguration
|
|
93
|
+
* // intentLabelingGenerationAIPromptId: "STRING_VALUE",
|
|
94
|
+
* // queryReformulationAIPromptId: "STRING_VALUE",
|
|
95
|
+
* // answerGenerationAIPromptId: "STRING_VALUE",
|
|
96
|
+
* // associationConfigurations: [
|
|
97
|
+
* // {
|
|
98
|
+
* // associationId: "STRING_VALUE",
|
|
99
|
+
* // associationType: "STRING_VALUE",
|
|
100
|
+
* // associationConfigurationData: {// Union: only one key present
|
|
101
|
+
* // knowledgeBaseAssociationConfigurationData: {
|
|
102
|
+
* // contentTagFilter: {// Union: only one key present
|
|
103
|
+
* // tagCondition: "<TagCondition>",
|
|
104
|
+
* // andConditions: [
|
|
105
|
+
* // "<TagCondition>",
|
|
106
|
+
* // ],
|
|
107
|
+
* // orConditions: [
|
|
108
|
+
* // {// Union: only one key present
|
|
109
|
+
* // andConditions: [
|
|
110
|
+
* // "<TagCondition>",
|
|
111
|
+
* // ],
|
|
112
|
+
* // tagCondition: "<TagCondition>",
|
|
113
|
+
* // },
|
|
114
|
+
* // ],
|
|
115
|
+
* // },
|
|
116
|
+
* // maxResults: Number("int"),
|
|
117
|
+
* // overrideKnowledgeBaseSearchType: "STRING_VALUE",
|
|
118
|
+
* // },
|
|
119
|
+
* // },
|
|
120
|
+
* // },
|
|
121
|
+
* // ],
|
|
122
|
+
* // },
|
|
123
|
+
* // },
|
|
124
|
+
* // origin: "STRING_VALUE",
|
|
125
|
+
* // description: "STRING_VALUE",
|
|
126
|
+
* // status: "STRING_VALUE",
|
|
127
|
+
* // tags: { // Tags
|
|
128
|
+
* // "<keys>": "STRING_VALUE",
|
|
129
|
+
* // },
|
|
130
|
+
* // },
|
|
131
|
+
* // ],
|
|
132
|
+
* // nextToken: "STRING_VALUE",
|
|
133
|
+
* // };
|
|
134
|
+
*
|
|
135
|
+
* ```
|
|
136
|
+
*
|
|
137
|
+
* @param ListAIAgentsCommandInput - {@link ListAIAgentsCommandInput}
|
|
138
|
+
* @returns {@link ListAIAgentsCommandOutput}
|
|
139
|
+
* @see {@link ListAIAgentsCommandInput} for command's `input` shape.
|
|
140
|
+
* @see {@link ListAIAgentsCommandOutput} for command's `response` shape.
|
|
141
|
+
* @see {@link QConnectClientResolvedConfig | config} for QConnectClient's `config` shape.
|
|
142
|
+
*
|
|
143
|
+
* @throws {@link AccessDeniedException} (client fault)
|
|
144
|
+
* <p>You do not have sufficient access to perform this action.</p>
|
|
145
|
+
*
|
|
146
|
+
* @throws {@link ResourceNotFoundException} (client fault)
|
|
147
|
+
* <p>The specified resource does not exist.</p>
|
|
148
|
+
*
|
|
149
|
+
* @throws {@link ThrottlingException} (client fault)
|
|
150
|
+
* <p>The throttling limit has been exceeded.</p>
|
|
151
|
+
*
|
|
152
|
+
* @throws {@link ValidationException} (client fault)
|
|
153
|
+
* <p>The input fails to satisfy the constraints specified by a service.</p>
|
|
154
|
+
*
|
|
155
|
+
* @throws {@link QConnectServiceException}
|
|
156
|
+
* <p>Base exception class for all service exceptions from QConnect service.</p>
|
|
157
|
+
*
|
|
158
|
+
* @public
|
|
159
|
+
*/
|
|
160
|
+
export declare class ListAIAgentsCommand extends ListAIAgentsCommand_base {
|
|
161
|
+
/** @internal type navigation helper, not in runtime. */
|
|
162
|
+
protected static __types: {
|
|
163
|
+
api: {
|
|
164
|
+
input: ListAIAgentsRequest;
|
|
165
|
+
output: ListAIAgentsResponse;
|
|
166
|
+
};
|
|
167
|
+
sdk: {
|
|
168
|
+
input: ListAIAgentsCommandInput;
|
|
169
|
+
output: ListAIAgentsCommandOutput;
|
|
170
|
+
};
|
|
171
|
+
};
|
|
172
|
+
}
|
|
@@ -0,0 +1,111 @@
|
|
|
1
|
+
import { Command as $Command } from "@smithy/smithy-client";
|
|
2
|
+
import { MetadataBearer as __MetadataBearer } from "@smithy/types";
|
|
3
|
+
import { ListAIPromptVersionsRequest, ListAIPromptVersionsResponse } from "../models/models_0";
|
|
4
|
+
import { QConnectClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../QConnectClient";
|
|
5
|
+
/**
|
|
6
|
+
* @public
|
|
7
|
+
*/
|
|
8
|
+
export type { __MetadataBearer };
|
|
9
|
+
export { $Command };
|
|
10
|
+
/**
|
|
11
|
+
* @public
|
|
12
|
+
*
|
|
13
|
+
* The input for {@link ListAIPromptVersionsCommand}.
|
|
14
|
+
*/
|
|
15
|
+
export interface ListAIPromptVersionsCommandInput extends ListAIPromptVersionsRequest {
|
|
16
|
+
}
|
|
17
|
+
/**
|
|
18
|
+
* @public
|
|
19
|
+
*
|
|
20
|
+
* The output of {@link ListAIPromptVersionsCommand}.
|
|
21
|
+
*/
|
|
22
|
+
export interface ListAIPromptVersionsCommandOutput extends ListAIPromptVersionsResponse, __MetadataBearer {
|
|
23
|
+
}
|
|
24
|
+
declare const ListAIPromptVersionsCommand_base: {
|
|
25
|
+
new (input: ListAIPromptVersionsCommandInput): import("@smithy/smithy-client").CommandImpl<ListAIPromptVersionsCommandInput, ListAIPromptVersionsCommandOutput, QConnectClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
26
|
+
new (__0_0: ListAIPromptVersionsCommandInput): import("@smithy/smithy-client").CommandImpl<ListAIPromptVersionsCommandInput, ListAIPromptVersionsCommandOutput, QConnectClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
27
|
+
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
|
+
};
|
|
29
|
+
/**
|
|
30
|
+
* <p>Lists AI Prompt versions.</p>
|
|
31
|
+
* @example
|
|
32
|
+
* Use a bare-bones client and the command you need to make an API call.
|
|
33
|
+
* ```javascript
|
|
34
|
+
* import { QConnectClient, ListAIPromptVersionsCommand } from "@aws-sdk/client-qconnect"; // ES Modules import
|
|
35
|
+
* // const { QConnectClient, ListAIPromptVersionsCommand } = require("@aws-sdk/client-qconnect"); // CommonJS import
|
|
36
|
+
* const client = new QConnectClient(config);
|
|
37
|
+
* const input = { // ListAIPromptVersionsRequest
|
|
38
|
+
* assistantId: "STRING_VALUE", // required
|
|
39
|
+
* aiPromptId: "STRING_VALUE", // required
|
|
40
|
+
* nextToken: "STRING_VALUE",
|
|
41
|
+
* maxResults: Number("int"),
|
|
42
|
+
* origin: "STRING_VALUE",
|
|
43
|
+
* };
|
|
44
|
+
* const command = new ListAIPromptVersionsCommand(input);
|
|
45
|
+
* const response = await client.send(command);
|
|
46
|
+
* // { // ListAIPromptVersionsResponse
|
|
47
|
+
* // aiPromptVersionSummaries: [ // AIPromptVersionSummariesList // required
|
|
48
|
+
* // { // AIPromptVersionSummary
|
|
49
|
+
* // aiPromptSummary: { // AIPromptSummary
|
|
50
|
+
* // name: "STRING_VALUE", // required
|
|
51
|
+
* // assistantId: "STRING_VALUE", // required
|
|
52
|
+
* // assistantArn: "STRING_VALUE", // required
|
|
53
|
+
* // aiPromptId: "STRING_VALUE", // required
|
|
54
|
+
* // type: "STRING_VALUE", // required
|
|
55
|
+
* // aiPromptArn: "STRING_VALUE", // required
|
|
56
|
+
* // modifiedTime: new Date("TIMESTAMP"),
|
|
57
|
+
* // templateType: "STRING_VALUE", // required
|
|
58
|
+
* // modelId: "STRING_VALUE", // required
|
|
59
|
+
* // apiFormat: "STRING_VALUE", // required
|
|
60
|
+
* // visibilityStatus: "STRING_VALUE", // required
|
|
61
|
+
* // origin: "STRING_VALUE",
|
|
62
|
+
* // description: "STRING_VALUE",
|
|
63
|
+
* // status: "STRING_VALUE",
|
|
64
|
+
* // tags: { // Tags
|
|
65
|
+
* // "<keys>": "STRING_VALUE",
|
|
66
|
+
* // },
|
|
67
|
+
* // },
|
|
68
|
+
* // versionNumber: Number("long"),
|
|
69
|
+
* // },
|
|
70
|
+
* // ],
|
|
71
|
+
* // nextToken: "STRING_VALUE",
|
|
72
|
+
* // };
|
|
73
|
+
*
|
|
74
|
+
* ```
|
|
75
|
+
*
|
|
76
|
+
* @param ListAIPromptVersionsCommandInput - {@link ListAIPromptVersionsCommandInput}
|
|
77
|
+
* @returns {@link ListAIPromptVersionsCommandOutput}
|
|
78
|
+
* @see {@link ListAIPromptVersionsCommandInput} for command's `input` shape.
|
|
79
|
+
* @see {@link ListAIPromptVersionsCommandOutput} for command's `response` shape.
|
|
80
|
+
* @see {@link QConnectClientResolvedConfig | config} for QConnectClient's `config` shape.
|
|
81
|
+
*
|
|
82
|
+
* @throws {@link AccessDeniedException} (client fault)
|
|
83
|
+
* <p>You do not have sufficient access to perform this action.</p>
|
|
84
|
+
*
|
|
85
|
+
* @throws {@link ResourceNotFoundException} (client fault)
|
|
86
|
+
* <p>The specified resource does not exist.</p>
|
|
87
|
+
*
|
|
88
|
+
* @throws {@link ThrottlingException} (client fault)
|
|
89
|
+
* <p>The throttling limit has been exceeded.</p>
|
|
90
|
+
*
|
|
91
|
+
* @throws {@link ValidationException} (client fault)
|
|
92
|
+
* <p>The input fails to satisfy the constraints specified by a service.</p>
|
|
93
|
+
*
|
|
94
|
+
* @throws {@link QConnectServiceException}
|
|
95
|
+
* <p>Base exception class for all service exceptions from QConnect service.</p>
|
|
96
|
+
*
|
|
97
|
+
* @public
|
|
98
|
+
*/
|
|
99
|
+
export declare class ListAIPromptVersionsCommand extends ListAIPromptVersionsCommand_base {
|
|
100
|
+
/** @internal type navigation helper, not in runtime. */
|
|
101
|
+
protected static __types: {
|
|
102
|
+
api: {
|
|
103
|
+
input: ListAIPromptVersionsRequest;
|
|
104
|
+
output: ListAIPromptVersionsResponse;
|
|
105
|
+
};
|
|
106
|
+
sdk: {
|
|
107
|
+
input: ListAIPromptVersionsCommandInput;
|
|
108
|
+
output: ListAIPromptVersionsCommandOutput;
|
|
109
|
+
};
|
|
110
|
+
};
|
|
111
|
+
}
|