@aws-sdk/client-bedrock-agent-runtime 3.1110.0 → 3.1112.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 +15 -1
- package/dist-cjs/index.js +302 -85
- package/dist-es/BedrockAgentRuntime.js +4 -0
- package/dist-es/commands/CheckIngestedDocumentAclCommand.js +4 -0
- package/dist-es/commands/GetIngestedDocumentAclCommand.js +4 -0
- package/dist-es/commands/index.js +2 -0
- package/dist-es/models/enums.js +26 -0
- package/dist-es/schemas/schemas_0.js +243 -84
- package/dist-types/BedrockAgentRuntime.d.ts +15 -1
- package/dist-types/BedrockAgentRuntimeClient.d.ts +5 -3
- package/dist-types/commands/AgenticRetrieveStreamCommand.d.ts +44 -2
- package/dist-types/commands/CheckIngestedDocumentAclCommand.d.ts +91 -0
- package/dist-types/commands/CreateInvocationCommand.d.ts +1 -1
- package/dist-types/commands/CreateSessionCommand.d.ts +1 -1
- package/dist-types/commands/DeleteSessionCommand.d.ts +1 -1
- package/dist-types/commands/EndSessionCommand.d.ts +1 -1
- package/dist-types/commands/GetIngestedDocumentAclCommand.d.ts +129 -0
- package/dist-types/commands/GetSessionCommand.d.ts +1 -1
- package/dist-types/commands/InvokeAgentCommand.d.ts +1 -1
- package/dist-types/commands/RetrieveAndGenerateStreamCommand.d.ts +1 -2
- package/dist-types/commands/RetrieveCommand.d.ts +1 -2
- package/dist-types/commands/index.d.ts +2 -0
- package/dist-types/index.d.ts +1 -1
- package/dist-types/models/enums.d.ts +100 -0
- package/dist-types/models/models_0.d.ts +454 -607
- package/dist-types/models/models_1.d.ts +582 -6
- package/dist-types/runtimeConfig.browser.d.ts +39 -39
- package/dist-types/runtimeConfig.d.ts +36 -36
- package/dist-types/runtimeConfig.native.d.ts +38 -38
- package/dist-types/runtimeConfig.shared.d.ts +2 -2
- package/dist-types/schemas/schemas_0.d.ts +19 -0
- package/dist-types/ts3.4/BedrockAgentRuntime.d.ts +34 -0
- package/dist-types/ts3.4/BedrockAgentRuntimeClient.d.ts +12 -0
- package/dist-types/ts3.4/commands/CheckIngestedDocumentAclCommand.d.ts +42 -0
- package/dist-types/ts3.4/commands/CreateInvocationCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/CreateSessionCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/DeleteSessionCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/EndSessionCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/GetIngestedDocumentAclCommand.d.ts +39 -0
- package/dist-types/ts3.4/commands/GetSessionCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/RetrieveAndGenerateStreamCommand.d.ts +4 -2
- package/dist-types/ts3.4/commands/RetrieveCommand.d.ts +1 -2
- package/dist-types/ts3.4/commands/index.d.ts +2 -0
- package/dist-types/ts3.4/models/enums.d.ts +34 -0
- package/dist-types/ts3.4/models/models_0.d.ts +155 -302
- package/dist-types/ts3.4/models/models_1.d.ts +320 -1
- package/dist-types/ts3.4/runtimeConfig.browser.d.ts +55 -57
- package/dist-types/ts3.4/runtimeConfig.d.ts +58 -58
- package/dist-types/ts3.4/runtimeConfig.native.d.ts +59 -61
- package/dist-types/ts3.4/runtimeConfig.shared.d.ts +3 -3
- package/dist-types/ts3.4/schemas/schemas_0.d.ts +19 -0
- package/package.json +5 -5
|
@@ -1,6 +1,7 @@
|
|
|
1
1
|
import type { HttpHandlerOptions as __HttpHandlerOptions, PaginationConfiguration, Paginator } from "@smithy/types";
|
|
2
2
|
import { BedrockAgentRuntimeClient } from "./BedrockAgentRuntimeClient";
|
|
3
3
|
import { type AgenticRetrieveStreamCommandInput, type AgenticRetrieveStreamCommandOutput } from "./commands/AgenticRetrieveStreamCommand";
|
|
4
|
+
import { type CheckIngestedDocumentAclCommandInput, type CheckIngestedDocumentAclCommandOutput } from "./commands/CheckIngestedDocumentAclCommand";
|
|
4
5
|
import { type CreateInvocationCommandInput, type CreateInvocationCommandOutput } from "./commands/CreateInvocationCommand";
|
|
5
6
|
import { type CreateSessionCommandInput, type CreateSessionCommandOutput } from "./commands/CreateSessionCommand";
|
|
6
7
|
import { type DeleteAgentMemoryCommandInput, type DeleteAgentMemoryCommandOutput } from "./commands/DeleteAgentMemoryCommand";
|
|
@@ -11,6 +12,7 @@ import { type GetAgentMemoryCommandInput, type GetAgentMemoryCommandOutput } fro
|
|
|
11
12
|
import { type GetDocumentContentCommandInput, type GetDocumentContentCommandOutput } from "./commands/GetDocumentContentCommand";
|
|
12
13
|
import { type GetExecutionFlowSnapshotCommandInput, type GetExecutionFlowSnapshotCommandOutput } from "./commands/GetExecutionFlowSnapshotCommand";
|
|
13
14
|
import { type GetFlowExecutionCommandInput, type GetFlowExecutionCommandOutput } from "./commands/GetFlowExecutionCommand";
|
|
15
|
+
import { type GetIngestedDocumentAclCommandInput, type GetIngestedDocumentAclCommandOutput } from "./commands/GetIngestedDocumentAclCommand";
|
|
14
16
|
import { type GetInvocationStepCommandInput, type GetInvocationStepCommandOutput } from "./commands/GetInvocationStepCommand";
|
|
15
17
|
import { type GetSessionCommandInput, type GetSessionCommandOutput } from "./commands/GetSessionCommand";
|
|
16
18
|
import { type InvokeAgentCommandInput, type InvokeAgentCommandOutput } from "./commands/InvokeAgentCommand";
|
|
@@ -40,6 +42,12 @@ export interface BedrockAgentRuntime {
|
|
|
40
42
|
agenticRetrieveStream(args: AgenticRetrieveStreamCommandInput, options?: __HttpHandlerOptions): Promise<AgenticRetrieveStreamCommandOutput>;
|
|
41
43
|
agenticRetrieveStream(args: AgenticRetrieveStreamCommandInput, cb: (err: any, data?: AgenticRetrieveStreamCommandOutput) => void): void;
|
|
42
44
|
agenticRetrieveStream(args: AgenticRetrieveStreamCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: AgenticRetrieveStreamCommandOutput) => void): void;
|
|
45
|
+
/**
|
|
46
|
+
* @see {@link CheckIngestedDocumentAclCommand}
|
|
47
|
+
*/
|
|
48
|
+
checkIngestedDocumentAcl(args: CheckIngestedDocumentAclCommandInput, options?: __HttpHandlerOptions): Promise<CheckIngestedDocumentAclCommandOutput>;
|
|
49
|
+
checkIngestedDocumentAcl(args: CheckIngestedDocumentAclCommandInput, cb: (err: any, data?: CheckIngestedDocumentAclCommandOutput) => void): void;
|
|
50
|
+
checkIngestedDocumentAcl(args: CheckIngestedDocumentAclCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CheckIngestedDocumentAclCommandOutput) => void): void;
|
|
43
51
|
/**
|
|
44
52
|
* @see {@link CreateInvocationCommand}
|
|
45
53
|
*/
|
|
@@ -101,6 +109,12 @@ export interface BedrockAgentRuntime {
|
|
|
101
109
|
getFlowExecution(args: GetFlowExecutionCommandInput, options?: __HttpHandlerOptions): Promise<GetFlowExecutionCommandOutput>;
|
|
102
110
|
getFlowExecution(args: GetFlowExecutionCommandInput, cb: (err: any, data?: GetFlowExecutionCommandOutput) => void): void;
|
|
103
111
|
getFlowExecution(args: GetFlowExecutionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetFlowExecutionCommandOutput) => void): void;
|
|
112
|
+
/**
|
|
113
|
+
* @see {@link GetIngestedDocumentAclCommand}
|
|
114
|
+
*/
|
|
115
|
+
getIngestedDocumentAcl(args: GetIngestedDocumentAclCommandInput, options?: __HttpHandlerOptions): Promise<GetIngestedDocumentAclCommandOutput>;
|
|
116
|
+
getIngestedDocumentAcl(args: GetIngestedDocumentAclCommandInput, cb: (err: any, data?: GetIngestedDocumentAclCommandOutput) => void): void;
|
|
117
|
+
getIngestedDocumentAcl(args: GetIngestedDocumentAclCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetIngestedDocumentAclCommandOutput) => void): void;
|
|
104
118
|
/**
|
|
105
119
|
* @see {@link GetInvocationStepCommand}
|
|
106
120
|
*/
|
|
@@ -292,7 +306,7 @@ export interface BedrockAgentRuntime {
|
|
|
292
306
|
paginateRetrieve(args: RetrieveCommandInput, paginationConfig?: Omit<PaginationConfiguration, "client">): Paginator<RetrieveCommandOutput>;
|
|
293
307
|
}
|
|
294
308
|
/**
|
|
295
|
-
* <p>Contains APIs related to model invocation and querying of knowledge bases.</p>
|
|
309
|
+
* <note> <p>Amazon Bedrock Agents (now Amazon Bedrock Agents Classic) is no longer open to new customers. For capabilities similar to Bedrock Agents Classic, explore Amazon Bedrock AgentCore. Existing customers can continue to use the service as normal. For more information, see <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/agents-classic-maintenance-mode.html">Amazon Bedrock Agents Classic availability change</a>.</p> </note> <p>Contains APIs related to model invocation and querying of knowledge bases.</p>
|
|
296
310
|
* @public
|
|
297
311
|
*/
|
|
298
312
|
export declare class BedrockAgentRuntime extends BedrockAgentRuntimeClient implements BedrockAgentRuntime {
|
|
@@ -8,6 +8,7 @@ import { type RetryInputConfig, type RetryResolvedConfig } from "@smithy/core/re
|
|
|
8
8
|
import type { AwsCredentialIdentityProvider, BodyLengthCalculator as __BodyLengthCalculator, CheckOptionalClientConfig as __CheckOptionalClientConfig, ChecksumConstructor as __ChecksumConstructor, Decoder as __Decoder, Encoder as __Encoder, EventStreamSerdeProvider as __EventStreamSerdeProvider, HashConstructor as __HashConstructor, HttpHandlerOptions as __HttpHandlerOptions, Logger as __Logger, Provider as __Provider, StreamCollector as __StreamCollector, UrlParser as __UrlParser, UserAgent as __UserAgent } from "@smithy/types";
|
|
9
9
|
import { type HttpAuthSchemeInputConfig, type HttpAuthSchemeResolvedConfig } from "./auth/httpAuthSchemeProvider";
|
|
10
10
|
import type { AgenticRetrieveStreamCommandInput, AgenticRetrieveStreamCommandOutput } from "./commands/AgenticRetrieveStreamCommand";
|
|
11
|
+
import type { CheckIngestedDocumentAclCommandInput, CheckIngestedDocumentAclCommandOutput } from "./commands/CheckIngestedDocumentAclCommand";
|
|
11
12
|
import type { CreateInvocationCommandInput, CreateInvocationCommandOutput } from "./commands/CreateInvocationCommand";
|
|
12
13
|
import type { CreateSessionCommandInput, CreateSessionCommandOutput } from "./commands/CreateSessionCommand";
|
|
13
14
|
import type { DeleteAgentMemoryCommandInput, DeleteAgentMemoryCommandOutput } from "./commands/DeleteAgentMemoryCommand";
|
|
@@ -18,6 +19,7 @@ import type { GetAgentMemoryCommandInput, GetAgentMemoryCommandOutput } from "./
|
|
|
18
19
|
import type { GetDocumentContentCommandInput, GetDocumentContentCommandOutput } from "./commands/GetDocumentContentCommand";
|
|
19
20
|
import type { GetExecutionFlowSnapshotCommandInput, GetExecutionFlowSnapshotCommandOutput } from "./commands/GetExecutionFlowSnapshotCommand";
|
|
20
21
|
import type { GetFlowExecutionCommandInput, GetFlowExecutionCommandOutput } from "./commands/GetFlowExecutionCommand";
|
|
22
|
+
import type { GetIngestedDocumentAclCommandInput, GetIngestedDocumentAclCommandOutput } from "./commands/GetIngestedDocumentAclCommand";
|
|
21
23
|
import type { GetInvocationStepCommandInput, GetInvocationStepCommandOutput } from "./commands/GetInvocationStepCommand";
|
|
22
24
|
import type { GetSessionCommandInput, GetSessionCommandOutput } from "./commands/GetSessionCommand";
|
|
23
25
|
import type { InvokeAgentCommandInput, InvokeAgentCommandOutput } from "./commands/InvokeAgentCommand";
|
|
@@ -46,11 +48,11 @@ export { __Client };
|
|
|
46
48
|
/**
|
|
47
49
|
* @public
|
|
48
50
|
*/
|
|
49
|
-
export type ServiceInputTypes = AgenticRetrieveStreamCommandInput | CreateInvocationCommandInput | CreateSessionCommandInput | DeleteAgentMemoryCommandInput | DeleteSessionCommandInput | EndSessionCommandInput | GenerateQueryCommandInput | GetAgentMemoryCommandInput | GetDocumentContentCommandInput | GetExecutionFlowSnapshotCommandInput | GetFlowExecutionCommandInput | GetInvocationStepCommandInput | GetSessionCommandInput | InvokeAgentCommandInput | InvokeFlowCommandInput | InvokeInlineAgentCommandInput | ListFlowExecutionEventsCommandInput | ListFlowExecutionsCommandInput | ListInvocationStepsCommandInput | ListInvocationsCommandInput | ListSessionsCommandInput | ListTagsForResourceCommandInput | OptimizePromptCommandInput | PutInvocationStepCommandInput | RerankCommandInput | RetrieveAndGenerateCommandInput | RetrieveAndGenerateStreamCommandInput | RetrieveCommandInput | StartFlowExecutionCommandInput | StopFlowExecutionCommandInput | TagResourceCommandInput | UntagResourceCommandInput | UpdateSessionCommandInput;
|
|
51
|
+
export type ServiceInputTypes = AgenticRetrieveStreamCommandInput | CheckIngestedDocumentAclCommandInput | CreateInvocationCommandInput | CreateSessionCommandInput | DeleteAgentMemoryCommandInput | DeleteSessionCommandInput | EndSessionCommandInput | GenerateQueryCommandInput | GetAgentMemoryCommandInput | GetDocumentContentCommandInput | GetExecutionFlowSnapshotCommandInput | GetFlowExecutionCommandInput | GetIngestedDocumentAclCommandInput | GetInvocationStepCommandInput | GetSessionCommandInput | InvokeAgentCommandInput | InvokeFlowCommandInput | InvokeInlineAgentCommandInput | ListFlowExecutionEventsCommandInput | ListFlowExecutionsCommandInput | ListInvocationStepsCommandInput | ListInvocationsCommandInput | ListSessionsCommandInput | ListTagsForResourceCommandInput | OptimizePromptCommandInput | PutInvocationStepCommandInput | RerankCommandInput | RetrieveAndGenerateCommandInput | RetrieveAndGenerateStreamCommandInput | RetrieveCommandInput | StartFlowExecutionCommandInput | StopFlowExecutionCommandInput | TagResourceCommandInput | UntagResourceCommandInput | UpdateSessionCommandInput;
|
|
50
52
|
/**
|
|
51
53
|
* @public
|
|
52
54
|
*/
|
|
53
|
-
export type ServiceOutputTypes = AgenticRetrieveStreamCommandOutput | CreateInvocationCommandOutput | CreateSessionCommandOutput | DeleteAgentMemoryCommandOutput | DeleteSessionCommandOutput | EndSessionCommandOutput | GenerateQueryCommandOutput | GetAgentMemoryCommandOutput | GetDocumentContentCommandOutput | GetExecutionFlowSnapshotCommandOutput | GetFlowExecutionCommandOutput | GetInvocationStepCommandOutput | GetSessionCommandOutput | InvokeAgentCommandOutput | InvokeFlowCommandOutput | InvokeInlineAgentCommandOutput | ListFlowExecutionEventsCommandOutput | ListFlowExecutionsCommandOutput | ListInvocationStepsCommandOutput | ListInvocationsCommandOutput | ListSessionsCommandOutput | ListTagsForResourceCommandOutput | OptimizePromptCommandOutput | PutInvocationStepCommandOutput | RerankCommandOutput | RetrieveAndGenerateCommandOutput | RetrieveAndGenerateStreamCommandOutput | RetrieveCommandOutput | StartFlowExecutionCommandOutput | StopFlowExecutionCommandOutput | TagResourceCommandOutput | UntagResourceCommandOutput | UpdateSessionCommandOutput;
|
|
55
|
+
export type ServiceOutputTypes = AgenticRetrieveStreamCommandOutput | CheckIngestedDocumentAclCommandOutput | CreateInvocationCommandOutput | CreateSessionCommandOutput | DeleteAgentMemoryCommandOutput | DeleteSessionCommandOutput | EndSessionCommandOutput | GenerateQueryCommandOutput | GetAgentMemoryCommandOutput | GetDocumentContentCommandOutput | GetExecutionFlowSnapshotCommandOutput | GetFlowExecutionCommandOutput | GetIngestedDocumentAclCommandOutput | GetInvocationStepCommandOutput | GetSessionCommandOutput | InvokeAgentCommandOutput | InvokeFlowCommandOutput | InvokeInlineAgentCommandOutput | ListFlowExecutionEventsCommandOutput | ListFlowExecutionsCommandOutput | ListInvocationStepsCommandOutput | ListInvocationsCommandOutput | ListSessionsCommandOutput | ListTagsForResourceCommandOutput | OptimizePromptCommandOutput | PutInvocationStepCommandOutput | RerankCommandOutput | RetrieveAndGenerateCommandOutput | RetrieveAndGenerateStreamCommandOutput | RetrieveCommandOutput | StartFlowExecutionCommandOutput | StopFlowExecutionCommandOutput | TagResourceCommandOutput | UntagResourceCommandOutput | UpdateSessionCommandOutput;
|
|
54
56
|
/**
|
|
55
57
|
* @public
|
|
56
58
|
*/
|
|
@@ -206,7 +208,7 @@ export type BedrockAgentRuntimeClientResolvedConfigType = __SmithyResolvedConfig
|
|
|
206
208
|
export interface BedrockAgentRuntimeClientResolvedConfig extends BedrockAgentRuntimeClientResolvedConfigType {
|
|
207
209
|
}
|
|
208
210
|
/**
|
|
209
|
-
* <p>Contains APIs related to model invocation and querying of knowledge bases.</p>
|
|
211
|
+
* <note> <p>Amazon Bedrock Agents (now Amazon Bedrock Agents Classic) is no longer open to new customers. For capabilities similar to Bedrock Agents Classic, explore Amazon Bedrock AgentCore. Existing customers can continue to use the service as normal. For more information, see <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/agents-classic-maintenance-mode.html">Amazon Bedrock Agents Classic availability change</a>.</p> </note> <p>Contains APIs related to model invocation and querying of knowledge bases.</p>
|
|
210
212
|
* @public
|
|
211
213
|
*/
|
|
212
214
|
export declare class BedrockAgentRuntimeClient extends __Client<__HttpHandlerOptions, ServiceInputTypes, ServiceOutputTypes, BedrockAgentRuntimeClientResolvedConfig> {
|
|
@@ -139,6 +139,39 @@ declare const AgenticRetrieveStreamCommand_base: {
|
|
|
139
139
|
* userContext: { // UserContext
|
|
140
140
|
* userId: "STRING_VALUE", // required
|
|
141
141
|
* },
|
|
142
|
+
* memoryConfiguration: { // AgenticRetrieveMemoryConfiguration
|
|
143
|
+
* memoryId: "STRING_VALUE", // required
|
|
144
|
+
* sessionBinding: { // AgenticRetrieveMemorySessionBinding
|
|
145
|
+
* actorId: "STRING_VALUE", // required
|
|
146
|
+
* sessionId: "STRING_VALUE", // required
|
|
147
|
+
* },
|
|
148
|
+
* retrievalConfigs: [ // AgenticRetrieveMemoryRetrievalConfigList
|
|
149
|
+
* { // AgenticRetrieveMemoryRetrievalConfig
|
|
150
|
+
* namespace: "STRING_VALUE",
|
|
151
|
+
* namespacePath: "STRING_VALUE",
|
|
152
|
+
* strategyId: "STRING_VALUE",
|
|
153
|
+
* metadataFilters: [ // AgenticRetrieveMemoryMetadataFilterList
|
|
154
|
+
* { // AgenticRetrieveMemoryMetadataFilter
|
|
155
|
+
* left: { // AgenticRetrieveMemoryMetadataFilterLeft Union: only one key present
|
|
156
|
+
* metadataKey: "STRING_VALUE",
|
|
157
|
+
* },
|
|
158
|
+
* operator: "EQUALS_TO" || "EXISTS" || "NOT_EXISTS" || "BEFORE" || "AFTER" || "CONTAINS" || "GREATER_THAN" || "GREATER_THAN_OR_EQUALS" || "LESS_THAN" || "LESS_THAN_OR_EQUALS", // required
|
|
159
|
+
* right: { // AgenticRetrieveMemoryMetadataFilterRight Union: only one key present
|
|
160
|
+
* metadataValue: { // AgenticRetrieveMemoryMetadataValue Union: only one key present
|
|
161
|
+
* stringValue: "STRING_VALUE",
|
|
162
|
+
* numberValue: Number("double"),
|
|
163
|
+
* stringListValue: [ // AgenticRetrieveMemoryMetadataStringList
|
|
164
|
+
* "STRING_VALUE",
|
|
165
|
+
* ],
|
|
166
|
+
* dateTimeValue: new Date("TIMESTAMP"),
|
|
167
|
+
* },
|
|
168
|
+
* },
|
|
169
|
+
* },
|
|
170
|
+
* ],
|
|
171
|
+
* },
|
|
172
|
+
* ],
|
|
173
|
+
* persistenceMode: "DEFAULT" || "NONE",
|
|
174
|
+
* },
|
|
142
175
|
* generateResponse: true || false,
|
|
143
176
|
* };
|
|
144
177
|
* const command = new AgenticRetrieveStreamCommand(input);
|
|
@@ -181,7 +214,7 @@ declare const AgenticRetrieveStreamCommand_base: {
|
|
|
181
214
|
* // id: "STRING_VALUE", // required
|
|
182
215
|
* // timestamp: Number("long"), // required
|
|
183
216
|
* // attributes: { // AgenticRetrieveTraceEventAttributes
|
|
184
|
-
* // step: "Planning" || "Retrieval" || "SpeculativeRetrieval" || "FullDocumentExpansion", // required
|
|
217
|
+
* // step: "Planning" || "Retrieval" || "SpeculativeRetrieval" || "FullDocumentExpansion" || "SessionHistoryLoad", // required
|
|
185
218
|
* // status: "IN_PROGRESS" || "SUCCEEDED" || "FAILED", // required
|
|
186
219
|
* // message: "STRING_VALUE", // required
|
|
187
220
|
* // actions: [ // AgenticRetrieveActions
|
|
@@ -200,6 +233,15 @@ declare const AgenticRetrieveStreamCommand_base: {
|
|
|
200
233
|
* // documentId: "STRING_VALUE",
|
|
201
234
|
* // sourceRetriever: "<AgenticRetrieveSourceRetriever>",
|
|
202
235
|
* // },
|
|
236
|
+
* // memoryRetrieve: { // AgenticRetrieveMemoryRetrieveDetails
|
|
237
|
+
* // inputQuery: {
|
|
238
|
+
* // text: "STRING_VALUE",
|
|
239
|
+
* // },
|
|
240
|
+
* // memoryId: "STRING_VALUE", // required
|
|
241
|
+
* // namespace: "STRING_VALUE",
|
|
242
|
+
* // namespacePath: "STRING_VALUE",
|
|
243
|
+
* // strategyId: "STRING_VALUE",
|
|
244
|
+
* // },
|
|
203
245
|
* // },
|
|
204
246
|
* // ],
|
|
205
247
|
* // warnings: [ // AgenticRetrieveWarnings
|
|
@@ -223,7 +265,7 @@ declare const AgenticRetrieveStreamCommand_base: {
|
|
|
223
265
|
* // retrievalMetadata: [ // AgenticRetrieveSourceMetadataList
|
|
224
266
|
* // { // AgenticRetrieveSourceMetadata
|
|
225
267
|
* // identifier: "STRING_VALUE",
|
|
226
|
-
* // retrievalType: "BedrockKnowledgeBase",
|
|
268
|
+
* // retrievalType: "BedrockKnowledgeBase" || "BedrockAgentCoreMemory",
|
|
227
269
|
* // },
|
|
228
270
|
* // ],
|
|
229
271
|
* // retrievalResponse: [ // AgenticRetrieveTraceResults
|
|
@@ -0,0 +1,91 @@
|
|
|
1
|
+
import type { MetadataBearer as __MetadataBearer } from "@smithy/types";
|
|
2
|
+
import type { CheckIngestedDocumentAclRequest, CheckIngestedDocumentAclResponse } from "../models/models_0";
|
|
3
|
+
/**
|
|
4
|
+
* @public
|
|
5
|
+
*/
|
|
6
|
+
export type { __MetadataBearer };
|
|
7
|
+
/**
|
|
8
|
+
* @public
|
|
9
|
+
*
|
|
10
|
+
* The input for {@link CheckIngestedDocumentAclCommand}.
|
|
11
|
+
*/
|
|
12
|
+
export interface CheckIngestedDocumentAclCommandInput extends CheckIngestedDocumentAclRequest {
|
|
13
|
+
}
|
|
14
|
+
/**
|
|
15
|
+
* @public
|
|
16
|
+
*
|
|
17
|
+
* The output of {@link CheckIngestedDocumentAclCommand}.
|
|
18
|
+
*/
|
|
19
|
+
export interface CheckIngestedDocumentAclCommandOutput extends CheckIngestedDocumentAclResponse, __MetadataBearer {
|
|
20
|
+
}
|
|
21
|
+
declare const CheckIngestedDocumentAclCommand_base: {
|
|
22
|
+
new (input: CheckIngestedDocumentAclCommandInput): import("@smithy/core/client").CommandImpl<CheckIngestedDocumentAclCommandInput, CheckIngestedDocumentAclCommandOutput, import("..").BedrockAgentRuntimeClientResolvedConfig, import("..").ServiceInputTypes, import("..").ServiceOutputTypes>;
|
|
23
|
+
new (input: CheckIngestedDocumentAclCommandInput): import("@smithy/core/client").CommandImpl<CheckIngestedDocumentAclCommandInput, CheckIngestedDocumentAclCommandOutput, import("..").BedrockAgentRuntimeClientResolvedConfig, import("..").ServiceInputTypes, import("..").ServiceOutputTypes>;
|
|
24
|
+
getEndpointParameterInstructions(): import("@smithy/types").EndpointParameterInstructions;
|
|
25
|
+
};
|
|
26
|
+
/**
|
|
27
|
+
* <p>Checks whether a user has access to a specific document by verifying against the ingested access control list (ACL) in a knowledge base. Use this operation to validate that document-level access control is working as expected after ingestion. To use this operation, you must have the <code>bedrock:CheckIngestedDocumentAcl</code> permission.</p>
|
|
28
|
+
* @example
|
|
29
|
+
* Use a bare-bones client and the command you need to make an API call.
|
|
30
|
+
* ```javascript
|
|
31
|
+
* import { BedrockAgentRuntimeClient, CheckIngestedDocumentAclCommand } from "@aws-sdk/client-bedrock-agent-runtime"; // ES Modules import
|
|
32
|
+
* // const { BedrockAgentRuntimeClient, CheckIngestedDocumentAclCommand } = require("@aws-sdk/client-bedrock-agent-runtime"); // CommonJS import
|
|
33
|
+
* // import type { BedrockAgentRuntimeClientConfig } from "@aws-sdk/client-bedrock-agent-runtime";
|
|
34
|
+
* const config = {}; // type is BedrockAgentRuntimeClientConfig
|
|
35
|
+
* const client = new BedrockAgentRuntimeClient(config);
|
|
36
|
+
* const input = { // CheckIngestedDocumentAclRequest
|
|
37
|
+
* knowledgeBaseId: "STRING_VALUE", // required
|
|
38
|
+
* dataSourceId: "STRING_VALUE", // required
|
|
39
|
+
* documentId: "STRING_VALUE", // required
|
|
40
|
+
* userContext: { // UserContext
|
|
41
|
+
* userId: "STRING_VALUE", // required
|
|
42
|
+
* },
|
|
43
|
+
* };
|
|
44
|
+
* const command = new CheckIngestedDocumentAclCommand(input);
|
|
45
|
+
* const response = await client.send(command);
|
|
46
|
+
* // { // CheckIngestedDocumentAclResponse
|
|
47
|
+
* // hasAccess: true || false, // required
|
|
48
|
+
* // };
|
|
49
|
+
*
|
|
50
|
+
* ```
|
|
51
|
+
*
|
|
52
|
+
* @param CheckIngestedDocumentAclCommandInput - {@link CheckIngestedDocumentAclCommandInput}
|
|
53
|
+
* @returns {@link CheckIngestedDocumentAclCommandOutput}
|
|
54
|
+
* @see {@link CheckIngestedDocumentAclCommandInput} for command's `input` shape.
|
|
55
|
+
* @see {@link CheckIngestedDocumentAclCommandOutput} for command's `response` shape.
|
|
56
|
+
* @see {@link BedrockAgentRuntimeClientResolvedConfig | config} for BedrockAgentRuntimeClient's `config` shape.
|
|
57
|
+
*
|
|
58
|
+
* @throws {@link AccessDeniedException} (client fault)
|
|
59
|
+
* <p>The request is denied because of missing access permissions. Check your permissions and retry your request.</p>
|
|
60
|
+
*
|
|
61
|
+
* @throws {@link InternalServerException} (server fault)
|
|
62
|
+
* <p>An internal server error occurred. Retry your request.</p>
|
|
63
|
+
*
|
|
64
|
+
* @throws {@link ResourceNotFoundException} (client fault)
|
|
65
|
+
* <p>The specified resource Amazon Resource Name (ARN) was not found. Check the Amazon Resource Name (ARN) and try your request again.</p>
|
|
66
|
+
*
|
|
67
|
+
* @throws {@link ThrottlingException} (client fault)
|
|
68
|
+
* <p>The number of requests exceeds the limit. Resubmit your request later.</p>
|
|
69
|
+
*
|
|
70
|
+
* @throws {@link ValidationException} (client fault)
|
|
71
|
+
* <p>Input validation failed. Check your request parameters and retry the request.</p>
|
|
72
|
+
*
|
|
73
|
+
* @throws {@link BedrockAgentRuntimeServiceException}
|
|
74
|
+
* <p>Base exception class for all service exceptions from BedrockAgentRuntime service.</p>
|
|
75
|
+
*
|
|
76
|
+
*
|
|
77
|
+
* @public
|
|
78
|
+
*/
|
|
79
|
+
export declare class CheckIngestedDocumentAclCommand extends CheckIngestedDocumentAclCommand_base {
|
|
80
|
+
/** @internal type navigation helper, not in runtime. */
|
|
81
|
+
protected static __types: {
|
|
82
|
+
api: {
|
|
83
|
+
input: CheckIngestedDocumentAclRequest;
|
|
84
|
+
output: CheckIngestedDocumentAclResponse;
|
|
85
|
+
};
|
|
86
|
+
sdk: {
|
|
87
|
+
input: CheckIngestedDocumentAclCommandInput;
|
|
88
|
+
output: CheckIngestedDocumentAclCommandOutput;
|
|
89
|
+
};
|
|
90
|
+
};
|
|
91
|
+
}
|
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
import type { MetadataBearer as __MetadataBearer } from "@smithy/types";
|
|
2
|
-
import type { CreateInvocationRequest, CreateInvocationResponse } from "../models/
|
|
2
|
+
import type { CreateInvocationRequest, CreateInvocationResponse } from "../models/models_1";
|
|
3
3
|
/**
|
|
4
4
|
* @public
|
|
5
5
|
*/
|
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
import type { MetadataBearer as __MetadataBearer } from "@smithy/types";
|
|
2
|
-
import type { CreateSessionRequest, CreateSessionResponse } from "../models/
|
|
2
|
+
import type { CreateSessionRequest, CreateSessionResponse } from "../models/models_1";
|
|
3
3
|
/**
|
|
4
4
|
* @public
|
|
5
5
|
*/
|
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
import type { MetadataBearer as __MetadataBearer } from "@smithy/types";
|
|
2
|
-
import type { DeleteSessionRequest, DeleteSessionResponse } from "../models/
|
|
2
|
+
import type { DeleteSessionRequest, DeleteSessionResponse } from "../models/models_1";
|
|
3
3
|
/**
|
|
4
4
|
* @public
|
|
5
5
|
*/
|
|
@@ -0,0 +1,129 @@
|
|
|
1
|
+
import type { MetadataBearer as __MetadataBearer } from "@smithy/types";
|
|
2
|
+
import type { GetIngestedDocumentAclRequest, GetIngestedDocumentAclResponse } from "../models/models_0";
|
|
3
|
+
/**
|
|
4
|
+
* @public
|
|
5
|
+
*/
|
|
6
|
+
export type { __MetadataBearer };
|
|
7
|
+
/**
|
|
8
|
+
* @public
|
|
9
|
+
*
|
|
10
|
+
* The input for {@link GetIngestedDocumentAclCommand}.
|
|
11
|
+
*/
|
|
12
|
+
export interface GetIngestedDocumentAclCommandInput extends GetIngestedDocumentAclRequest {
|
|
13
|
+
}
|
|
14
|
+
/**
|
|
15
|
+
* @public
|
|
16
|
+
*
|
|
17
|
+
* The output of {@link GetIngestedDocumentAclCommand}.
|
|
18
|
+
*/
|
|
19
|
+
export interface GetIngestedDocumentAclCommandOutput extends GetIngestedDocumentAclResponse, __MetadataBearer {
|
|
20
|
+
}
|
|
21
|
+
declare const GetIngestedDocumentAclCommand_base: {
|
|
22
|
+
new (input: GetIngestedDocumentAclCommandInput): import("@smithy/core/client").CommandImpl<GetIngestedDocumentAclCommandInput, GetIngestedDocumentAclCommandOutput, import("..").BedrockAgentRuntimeClientResolvedConfig, import("..").ServiceInputTypes, import("..").ServiceOutputTypes>;
|
|
23
|
+
new (input: GetIngestedDocumentAclCommandInput): import("@smithy/core/client").CommandImpl<GetIngestedDocumentAclCommandInput, GetIngestedDocumentAclCommandOutput, import("..").BedrockAgentRuntimeClientResolvedConfig, import("..").ServiceInputTypes, import("..").ServiceOutputTypes>;
|
|
24
|
+
getEndpointParameterInstructions(): import("@smithy/types").EndpointParameterInstructions;
|
|
25
|
+
};
|
|
26
|
+
/**
|
|
27
|
+
* <p>Retrieves the ingested access control list (ACL) for a specific document in a knowledge base. Use this operation to inspect the allow and deny lists that were ingested for a document to troubleshoot access control issues. To use this operation, you must have the <code>bedrock:GetIngestedDocumentAcl</code> permission.</p>
|
|
28
|
+
* @example
|
|
29
|
+
* Use a bare-bones client and the command you need to make an API call.
|
|
30
|
+
* ```javascript
|
|
31
|
+
* import { BedrockAgentRuntimeClient, GetIngestedDocumentAclCommand } from "@aws-sdk/client-bedrock-agent-runtime"; // ES Modules import
|
|
32
|
+
* // const { BedrockAgentRuntimeClient, GetIngestedDocumentAclCommand } = require("@aws-sdk/client-bedrock-agent-runtime"); // CommonJS import
|
|
33
|
+
* // import type { BedrockAgentRuntimeClientConfig } from "@aws-sdk/client-bedrock-agent-runtime";
|
|
34
|
+
* const config = {}; // type is BedrockAgentRuntimeClientConfig
|
|
35
|
+
* const client = new BedrockAgentRuntimeClient(config);
|
|
36
|
+
* const input = { // GetIngestedDocumentAclRequest
|
|
37
|
+
* knowledgeBaseId: "STRING_VALUE", // required
|
|
38
|
+
* dataSourceId: "STRING_VALUE", // required
|
|
39
|
+
* documentId: "STRING_VALUE", // required
|
|
40
|
+
* };
|
|
41
|
+
* const command = new GetIngestedDocumentAclCommand(input);
|
|
42
|
+
* const response = await client.send(command);
|
|
43
|
+
* // { // GetIngestedDocumentAclResponse
|
|
44
|
+
* // documentAcl: { // DocumentAcl
|
|
45
|
+
* // allowList: { // DocumentAclMembership
|
|
46
|
+
* // memberRelation: "AND" || "OR",
|
|
47
|
+
* // conditions: [ // DocumentAclConditionList
|
|
48
|
+
* // { // DocumentAclCondition
|
|
49
|
+
* // conditionOperator: "AND" || "OR",
|
|
50
|
+
* // users: [ // DocumentAclUserList
|
|
51
|
+
* // { // DocumentAclUser
|
|
52
|
+
* // id: "STRING_VALUE", // required
|
|
53
|
+
* // type: "KNOWLEDGE_BASE" || "DATA_SOURCE", // required
|
|
54
|
+
* // },
|
|
55
|
+
* // ],
|
|
56
|
+
* // groups: [ // DocumentAclGroupList
|
|
57
|
+
* // { // DocumentAclGroup
|
|
58
|
+
* // id: "STRING_VALUE", // required
|
|
59
|
+
* // type: "KNOWLEDGE_BASE" || "DATA_SOURCE", // required
|
|
60
|
+
* // },
|
|
61
|
+
* // ],
|
|
62
|
+
* // },
|
|
63
|
+
* // ],
|
|
64
|
+
* // },
|
|
65
|
+
* // denyList: {
|
|
66
|
+
* // memberRelation: "AND" || "OR",
|
|
67
|
+
* // conditions: [
|
|
68
|
+
* // {
|
|
69
|
+
* // conditionOperator: "AND" || "OR",
|
|
70
|
+
* // users: [
|
|
71
|
+
* // {
|
|
72
|
+
* // id: "STRING_VALUE", // required
|
|
73
|
+
* // type: "KNOWLEDGE_BASE" || "DATA_SOURCE", // required
|
|
74
|
+
* // },
|
|
75
|
+
* // ],
|
|
76
|
+
* // groups: [
|
|
77
|
+
* // {
|
|
78
|
+
* // id: "STRING_VALUE", // required
|
|
79
|
+
* // type: "KNOWLEDGE_BASE" || "DATA_SOURCE", // required
|
|
80
|
+
* // },
|
|
81
|
+
* // ],
|
|
82
|
+
* // },
|
|
83
|
+
* // ],
|
|
84
|
+
* // },
|
|
85
|
+
* // },
|
|
86
|
+
* // };
|
|
87
|
+
*
|
|
88
|
+
* ```
|
|
89
|
+
*
|
|
90
|
+
* @param GetIngestedDocumentAclCommandInput - {@link GetIngestedDocumentAclCommandInput}
|
|
91
|
+
* @returns {@link GetIngestedDocumentAclCommandOutput}
|
|
92
|
+
* @see {@link GetIngestedDocumentAclCommandInput} for command's `input` shape.
|
|
93
|
+
* @see {@link GetIngestedDocumentAclCommandOutput} for command's `response` shape.
|
|
94
|
+
* @see {@link BedrockAgentRuntimeClientResolvedConfig | config} for BedrockAgentRuntimeClient's `config` shape.
|
|
95
|
+
*
|
|
96
|
+
* @throws {@link AccessDeniedException} (client fault)
|
|
97
|
+
* <p>The request is denied because of missing access permissions. Check your permissions and retry your request.</p>
|
|
98
|
+
*
|
|
99
|
+
* @throws {@link InternalServerException} (server fault)
|
|
100
|
+
* <p>An internal server error occurred. Retry your request.</p>
|
|
101
|
+
*
|
|
102
|
+
* @throws {@link ResourceNotFoundException} (client fault)
|
|
103
|
+
* <p>The specified resource Amazon Resource Name (ARN) was not found. Check the Amazon Resource Name (ARN) and try your request again.</p>
|
|
104
|
+
*
|
|
105
|
+
* @throws {@link ThrottlingException} (client fault)
|
|
106
|
+
* <p>The number of requests exceeds the limit. Resubmit your request later.</p>
|
|
107
|
+
*
|
|
108
|
+
* @throws {@link ValidationException} (client fault)
|
|
109
|
+
* <p>Input validation failed. Check your request parameters and retry the request.</p>
|
|
110
|
+
*
|
|
111
|
+
* @throws {@link BedrockAgentRuntimeServiceException}
|
|
112
|
+
* <p>Base exception class for all service exceptions from BedrockAgentRuntime service.</p>
|
|
113
|
+
*
|
|
114
|
+
*
|
|
115
|
+
* @public
|
|
116
|
+
*/
|
|
117
|
+
export declare class GetIngestedDocumentAclCommand extends GetIngestedDocumentAclCommand_base {
|
|
118
|
+
/** @internal type navigation helper, not in runtime. */
|
|
119
|
+
protected static __types: {
|
|
120
|
+
api: {
|
|
121
|
+
input: GetIngestedDocumentAclRequest;
|
|
122
|
+
output: GetIngestedDocumentAclResponse;
|
|
123
|
+
};
|
|
124
|
+
sdk: {
|
|
125
|
+
input: GetIngestedDocumentAclCommandInput;
|
|
126
|
+
output: GetIngestedDocumentAclCommandOutput;
|
|
127
|
+
};
|
|
128
|
+
};
|
|
129
|
+
}
|
|
@@ -25,7 +25,7 @@ declare const InvokeAgentCommand_base: {
|
|
|
25
25
|
getEndpointParameterInstructions(): import("@smithy/types").EndpointParameterInstructions;
|
|
26
26
|
};
|
|
27
27
|
/**
|
|
28
|
-
* <note> </note> <p>Sends a prompt for the agent to process and respond to. Note the following fields for the request:</p> <ul> <li> <p>To continue the same conversation with an agent, use the same <code>sessionId</code> value in the request.</p> </li> <li> <p>To activate trace enablement, turn <code>enableTrace</code> to <code>true</code>. Trace enablement helps you follow the agent's reasoning process that led it to the information it processed, the actions it took, and the final result it yielded. For more information, see <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/agents-test.html#trace-events">Trace enablement</a>.</p> </li> <li> <p>End a conversation by setting <code>endSession</code> to <code>true</code>.</p> </li> <li> <p>In the <code>sessionState</code> object, you can include attributes for the session or prompt or, if you configured an action group to return control, results from invocation of the action group.</p> </li> </ul> <p>The response contains both <b>chunk</b> and <b>trace</b> attributes.</p> <p>The final response is returned in the <code>bytes</code> field of the <code>chunk</code> object. The <code>InvokeAgent</code> returns one chunk for the entire interaction.</p> <ul> <li> <p>The <code>attribution</code> object contains citations for parts of the response.</p> </li> <li> <p>If you set <code>enableTrace</code> to <code>true</code> in the request, you can trace the agent's steps and reasoning process that led it to the response.</p> </li> <li> <p>If the action predicted was configured to return control, the response returns parameters for the action, elicited from the user, in the <code>returnControl</code> field.</p> </li> <li> <p>Errors are also surfaced in the response.</p> </li> </ul>
|
|
28
|
+
* <note> <p>Amazon Bedrock Agents (now Amazon Bedrock Agents Classic) is no longer open to new customers. For capabilities similar to Bedrock Agents Classic, explore Amazon Bedrock AgentCore. Existing customers can continue to use the service as normal. For more information, see <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/agents-classic-maintenance-mode.html">Amazon Bedrock Agents Classic availability change</a>.</p> </note> <note> </note> <p>Sends a prompt for the agent to process and respond to. Note the following fields for the request:</p> <ul> <li> <p>To continue the same conversation with an agent, use the same <code>sessionId</code> value in the request.</p> </li> <li> <p>To activate trace enablement, turn <code>enableTrace</code> to <code>true</code>. Trace enablement helps you follow the agent's reasoning process that led it to the information it processed, the actions it took, and the final result it yielded. For more information, see <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/agents-test.html#trace-events">Trace enablement</a>.</p> </li> <li> <p>End a conversation by setting <code>endSession</code> to <code>true</code>.</p> </li> <li> <p>In the <code>sessionState</code> object, you can include attributes for the session or prompt or, if you configured an action group to return control, results from invocation of the action group.</p> </li> </ul> <p>The response contains both <b>chunk</b> and <b>trace</b> attributes.</p> <p>The final response is returned in the <code>bytes</code> field of the <code>chunk</code> object. The <code>InvokeAgent</code> returns one chunk for the entire interaction.</p> <ul> <li> <p>The <code>attribution</code> object contains citations for parts of the response.</p> </li> <li> <p>If you set <code>enableTrace</code> to <code>true</code> in the request, you can trace the agent's steps and reasoning process that led it to the response.</p> </li> <li> <p>If the action predicted was configured to return control, the response returns parameters for the action, elicited from the user, in the <code>returnControl</code> field.</p> </li> <li> <p>Errors are also surfaced in the response.</p> </li> </ul>
|
|
29
29
|
* @example
|
|
30
30
|
* Use a bare-bones client and the command you need to make an API call.
|
|
31
31
|
* ```javascript
|
|
@@ -1,6 +1,5 @@
|
|
|
1
1
|
import type { MetadataBearer as __MetadataBearer } from "@smithy/types";
|
|
2
|
-
import type { RetrieveAndGenerateStreamResponse } from "../models/
|
|
3
|
-
import type { RetrieveAndGenerateStreamRequest } from "../models/models_1";
|
|
2
|
+
import type { RetrieveAndGenerateStreamRequest, RetrieveAndGenerateStreamResponse } from "../models/models_1";
|
|
4
3
|
/**
|
|
5
4
|
* @public
|
|
6
5
|
*/
|
|
@@ -1,6 +1,5 @@
|
|
|
1
1
|
import type { MetadataBearer as __MetadataBearer } from "@smithy/types";
|
|
2
|
-
import type { RetrieveResponse } from "../models/
|
|
3
|
-
import type { RetrieveRequest } from "../models/models_1";
|
|
2
|
+
import type { RetrieveRequest, RetrieveResponse } from "../models/models_1";
|
|
4
3
|
/**
|
|
5
4
|
* @public
|
|
6
5
|
*/
|
|
@@ -1,4 +1,5 @@
|
|
|
1
1
|
export * from "./AgenticRetrieveStreamCommand";
|
|
2
|
+
export * from "./CheckIngestedDocumentAclCommand";
|
|
2
3
|
export * from "./CreateInvocationCommand";
|
|
3
4
|
export * from "./CreateSessionCommand";
|
|
4
5
|
export * from "./DeleteAgentMemoryCommand";
|
|
@@ -9,6 +10,7 @@ export * from "./GetAgentMemoryCommand";
|
|
|
9
10
|
export * from "./GetDocumentContentCommand";
|
|
10
11
|
export * from "./GetExecutionFlowSnapshotCommand";
|
|
11
12
|
export * from "./GetFlowExecutionCommand";
|
|
13
|
+
export * from "./GetIngestedDocumentAclCommand";
|
|
12
14
|
export * from "./GetInvocationStepCommand";
|
|
13
15
|
export * from "./GetSessionCommand";
|
|
14
16
|
export * from "./InvokeAgentCommand";
|
package/dist-types/index.d.ts
CHANGED
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
/**
|
|
2
|
-
* <p>Contains APIs related to model invocation and querying of knowledge bases.</p>
|
|
2
|
+
* <note> <p>Amazon Bedrock Agents (now Amazon Bedrock Agents Classic) is no longer open to new customers. For capabilities similar to Bedrock Agents Classic, explore Amazon Bedrock AgentCore. Existing customers can continue to use the service as normal. For more information, see <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/agents-classic-maintenance-mode.html">Amazon Bedrock Agents Classic availability change</a>.</p> </note> <p>Contains APIs related to model invocation and querying of knowledge bases.</p>
|
|
3
3
|
*
|
|
4
4
|
* @packageDocumentation
|
|
5
5
|
*/
|
|
@@ -198,6 +198,74 @@ export declare const GuardrailAction: {
|
|
|
198
198
|
* @public
|
|
199
199
|
*/
|
|
200
200
|
export type GuardrailAction = (typeof GuardrailAction)[keyof typeof GuardrailAction];
|
|
201
|
+
/**
|
|
202
|
+
* @public
|
|
203
|
+
* @enum
|
|
204
|
+
*/
|
|
205
|
+
export declare const AgenticRetrieveMemoryPersistenceMode: {
|
|
206
|
+
/**
|
|
207
|
+
* <p>Specifies that the question and the agent-generated answer are persisted to the session. This is the default when persistenceMode is omitted.</p>
|
|
208
|
+
*/
|
|
209
|
+
readonly DEFAULT: "DEFAULT";
|
|
210
|
+
/**
|
|
211
|
+
* <p>Specifies that the session is left unchanged.</p>
|
|
212
|
+
*/
|
|
213
|
+
readonly NONE: "NONE";
|
|
214
|
+
};
|
|
215
|
+
/**
|
|
216
|
+
* @public
|
|
217
|
+
*/
|
|
218
|
+
export type AgenticRetrieveMemoryPersistenceMode = (typeof AgenticRetrieveMemoryPersistenceMode)[keyof typeof AgenticRetrieveMemoryPersistenceMode];
|
|
219
|
+
/**
|
|
220
|
+
* @public
|
|
221
|
+
* @enum
|
|
222
|
+
*/
|
|
223
|
+
export declare const AgenticRetrieveMemoryMetadataFilterOperator: {
|
|
224
|
+
/**
|
|
225
|
+
* <p>The AFTER operator matches memory records whose timestamp metadata value falls after the supplied value.</p>
|
|
226
|
+
*/
|
|
227
|
+
readonly AFTER: "AFTER";
|
|
228
|
+
/**
|
|
229
|
+
* <p>The BEFORE operator matches memory records whose timestamp metadata value falls before the supplied value.</p>
|
|
230
|
+
*/
|
|
231
|
+
readonly BEFORE: "BEFORE";
|
|
232
|
+
/**
|
|
233
|
+
* <p>The CONTAINS operator matches memory records whose metadata value contains the supplied value.</p>
|
|
234
|
+
*/
|
|
235
|
+
readonly CONTAINS: "CONTAINS";
|
|
236
|
+
/**
|
|
237
|
+
* <p>The EQUALS_TO operator matches memory records whose metadata value equals the supplied value.</p>
|
|
238
|
+
*/
|
|
239
|
+
readonly EQUALS_TO: "EQUALS_TO";
|
|
240
|
+
/**
|
|
241
|
+
* <p>The EXISTS operator matches memory records that carry the metadata key, whatever its value. This operator takes no right operand.</p>
|
|
242
|
+
*/
|
|
243
|
+
readonly EXISTS: "EXISTS";
|
|
244
|
+
/**
|
|
245
|
+
* <p>The GREATER_THAN operator matches memory records whose numeric metadata value is greater than the supplied value.</p>
|
|
246
|
+
*/
|
|
247
|
+
readonly GREATER_THAN: "GREATER_THAN";
|
|
248
|
+
/**
|
|
249
|
+
* <p>The GREATER_THAN_OR_EQUALS operator matches memory records whose numeric metadata value is greater than or equal to the supplied value.</p>
|
|
250
|
+
*/
|
|
251
|
+
readonly GREATER_THAN_OR_EQUALS: "GREATER_THAN_OR_EQUALS";
|
|
252
|
+
/**
|
|
253
|
+
* <p>The LESS_THAN operator matches memory records whose numeric metadata value is less than the supplied value.</p>
|
|
254
|
+
*/
|
|
255
|
+
readonly LESS_THAN: "LESS_THAN";
|
|
256
|
+
/**
|
|
257
|
+
* <p>The LESS_THAN_OR_EQUALS operator matches memory records whose numeric metadata value is less than or equal to the supplied value.</p>
|
|
258
|
+
*/
|
|
259
|
+
readonly LESS_THAN_OR_EQUALS: "LESS_THAN_OR_EQUALS";
|
|
260
|
+
/**
|
|
261
|
+
* <p>The NOT_EXISTS operator matches memory records that do not carry the metadata key. This operator takes no right operand.</p>
|
|
262
|
+
*/
|
|
263
|
+
readonly NOT_EXISTS: "NOT_EXISTS";
|
|
264
|
+
};
|
|
265
|
+
/**
|
|
266
|
+
* @public
|
|
267
|
+
*/
|
|
268
|
+
export type AgenticRetrieveMemoryMetadataFilterOperator = (typeof AgenticRetrieveMemoryMetadataFilterOperator)[keyof typeof AgenticRetrieveMemoryMetadataFilterOperator];
|
|
201
269
|
/**
|
|
202
270
|
* @public
|
|
203
271
|
* @enum
|
|
@@ -215,6 +283,10 @@ export type ConversationRole = (typeof ConversationRole)[keyof typeof Conversati
|
|
|
215
283
|
* @enum
|
|
216
284
|
*/
|
|
217
285
|
export declare const AgenticRetrieveType: {
|
|
286
|
+
/**
|
|
287
|
+
* <p>An AgentCore Memory resource. Long-term memory retrievals report under the Retrieval step with this source type.</p>
|
|
288
|
+
*/
|
|
289
|
+
readonly BEDROCK_AGENT_CORE_MEMORY: "BedrockAgentCoreMemory";
|
|
218
290
|
/**
|
|
219
291
|
* <p>A Bedrock knowledge base retrieval source.</p>
|
|
220
292
|
*/
|
|
@@ -263,6 +335,10 @@ export declare const AgenticRetrieveStep: {
|
|
|
263
335
|
* <p>The retrieval phase where data is fetched.</p>
|
|
264
336
|
*/
|
|
265
337
|
readonly RETRIEVAL: "Retrieval";
|
|
338
|
+
/**
|
|
339
|
+
* <p>The phase that restores prior session history from AgentCore Memory short-term memory, before the agent begins work.</p>
|
|
340
|
+
*/
|
|
341
|
+
readonly SESSION_HISTORY_LOAD: "SessionHistoryLoad";
|
|
266
342
|
/**
|
|
267
343
|
* <p>A speculative retrieval phase for optimization.</p>
|
|
268
344
|
*/
|
|
@@ -734,6 +810,30 @@ export declare const DocumentOutputFormat: {
|
|
|
734
810
|
* @public
|
|
735
811
|
*/
|
|
736
812
|
export type DocumentOutputFormat = (typeof DocumentOutputFormat)[keyof typeof DocumentOutputFormat];
|
|
813
|
+
/**
|
|
814
|
+
* @public
|
|
815
|
+
* @enum
|
|
816
|
+
*/
|
|
817
|
+
export declare const DocumentAclMemberRelation: {
|
|
818
|
+
readonly AND: "AND";
|
|
819
|
+
readonly OR: "OR";
|
|
820
|
+
};
|
|
821
|
+
/**
|
|
822
|
+
* @public
|
|
823
|
+
*/
|
|
824
|
+
export type DocumentAclMemberRelation = (typeof DocumentAclMemberRelation)[keyof typeof DocumentAclMemberRelation];
|
|
825
|
+
/**
|
|
826
|
+
* @public
|
|
827
|
+
* @enum
|
|
828
|
+
*/
|
|
829
|
+
export declare const DocumentAclMembershipType: {
|
|
830
|
+
readonly DATA_SOURCE: "DATA_SOURCE";
|
|
831
|
+
readonly KNOWLEDGE_BASE: "KNOWLEDGE_BASE";
|
|
832
|
+
};
|
|
833
|
+
/**
|
|
834
|
+
* @public
|
|
835
|
+
*/
|
|
836
|
+
export type DocumentAclMembershipType = (typeof DocumentAclMembershipType)[keyof typeof DocumentAclMembershipType];
|
|
737
837
|
/**
|
|
738
838
|
* @public
|
|
739
839
|
* @enum
|