@aws-sdk/client-bedrock-agent 3.1152.0 → 3.1153.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 +49 -0
- package/dist-cjs/index.js +263 -1
- package/dist-es/BedrockAgent.js +18 -0
- package/dist-es/commands/CreateRetrievalInstructionCommand.js +4 -0
- package/dist-es/commands/CreateRetrievalInstructionVersionCommand.js +4 -0
- package/dist-es/commands/DeleteRetrievalInstructionCommand.js +4 -0
- package/dist-es/commands/GetRetrievalInstructionCommand.js +4 -0
- package/dist-es/commands/ListRetrievalInstructionVersionsCommand.js +4 -0
- package/dist-es/commands/ListRetrievalInstructionsCommand.js +4 -0
- package/dist-es/commands/UpdateRetrievalInstructionCommand.js +4 -0
- package/dist-es/commands/index.js +7 -0
- package/dist-es/models/enums.js +23 -0
- package/dist-es/pagination/ListRetrievalInstructionVersionsPaginator.js +4 -0
- package/dist-es/pagination/ListRetrievalInstructionsPaginator.js +4 -0
- package/dist-es/pagination/index.js +2 -0
- package/dist-es/schemas/schemas_0.js +167 -0
- package/dist-types/BedrockAgent.d.ts +64 -0
- package/dist-types/BedrockAgentClient.d.ts +9 -2
- package/dist-types/commands/CreateRetrievalInstructionCommand.d.ts +107 -0
- package/dist-types/commands/CreateRetrievalInstructionVersionCommand.d.ts +98 -0
- package/dist-types/commands/DeleteRetrievalInstructionCommand.d.ts +92 -0
- package/dist-types/commands/GetRetrievalInstructionCommand.d.ts +110 -0
- package/dist-types/commands/ListRetrievalInstructionVersionsCommand.d.ts +94 -0
- package/dist-types/commands/ListRetrievalInstructionsCommand.d.ts +97 -0
- package/dist-types/commands/UpdateRetrievalInstructionCommand.d.ts +102 -0
- package/dist-types/commands/index.d.ts +7 -0
- package/dist-types/models/enums.d.ts +55 -0
- package/dist-types/models/models_1.d.ts +485 -1
- package/dist-types/pagination/ListRetrievalInstructionVersionsPaginator.d.ts +7 -0
- package/dist-types/pagination/ListRetrievalInstructionsPaginator.d.ts +7 -0
- package/dist-types/pagination/index.d.ts +2 -0
- package/dist-types/schemas/schemas_0.d.ts +25 -0
- package/dist-types/ts3.4/BedrockAgent.d.ts +134 -0
- package/dist-types/ts3.4/BedrockAgentClient.d.ts +42 -0
- package/dist-types/ts3.4/commands/CreateRetrievalInstructionCommand.d.ts +42 -0
- package/dist-types/ts3.4/commands/CreateRetrievalInstructionVersionCommand.d.ts +42 -0
- package/dist-types/ts3.4/commands/DeleteRetrievalInstructionCommand.d.ts +42 -0
- package/dist-types/ts3.4/commands/GetRetrievalInstructionCommand.d.ts +42 -0
- package/dist-types/ts3.4/commands/ListRetrievalInstructionVersionsCommand.d.ts +42 -0
- package/dist-types/ts3.4/commands/ListRetrievalInstructionsCommand.d.ts +42 -0
- package/dist-types/ts3.4/commands/UpdateRetrievalInstructionCommand.d.ts +42 -0
- package/dist-types/ts3.4/commands/index.d.ts +7 -0
- package/dist-types/ts3.4/models/enums.d.ts +31 -0
- package/dist-types/ts3.4/models/models_1.d.ts +118 -0
- package/dist-types/ts3.4/pagination/ListRetrievalInstructionVersionsPaginator.d.ts +11 -0
- package/dist-types/ts3.4/pagination/ListRetrievalInstructionsPaginator.d.ts +11 -0
- package/dist-types/ts3.4/pagination/index.d.ts +2 -0
- package/dist-types/ts3.4/schemas/schemas_0.d.ts +25 -0
- package/package.json +4 -4
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
import { AutomaticJsonStringConversion as __AutomaticJsonStringConversion } from "@smithy/core/serde";
|
|
2
2
|
import type { DocumentType as __DocumentType } from "@smithy/types";
|
|
3
|
-
import type { AgentStatus, EmbeddingDataType, EmbeddingModelType, FlowNodeType, FlowStatus, IncludedData, IncludeExclude, KnowledgeBaseState, KnowledgeBaseStatus, KnowledgeBaseStorageType, KnowledgeBaseType, PromptTemplateType, QueryEngineType, RedshiftProvisionedAuthType, RedshiftQueryEngineStorageType, RedshiftQueryEngineType, RedshiftServerlessAuthType, SupplementalDataStorageLocationType, VpcConfigurationStatus, VpcProtocol, VpcResolutionMode } from "./enums";
|
|
3
|
+
import type { AgentStatus, EmbeddingDataType, EmbeddingModelType, FlowNodeType, FlowStatus, IncludedData, IncludeExclude, KnowledgeBaseState, KnowledgeBaseStatus, KnowledgeBaseStorageType, KnowledgeBaseType, PromptTemplateType, QueryEngineType, RedshiftProvisionedAuthType, RedshiftQueryEngineStorageType, RedshiftQueryEngineType, RedshiftServerlessAuthType, RetrievalInstructionFailureReasonCode, RetrievalInstructionFieldName, RetrievalInstructionLastTransitionStatus, RetrievalInstructionStatus, SupplementalDataStorageLocationType, VpcConfigurationStatus, VpcProtocol, VpcResolutionMode } from "./enums";
|
|
4
4
|
import type { AgentFlowNodeConfiguration, AgentKnowledgeBase, AgentKnowledgeBaseSummary, AgentVersion, AgentVersionSummary, CollectorFlowNodeConfiguration, ConditionFlowNodeConfiguration, FlowConnection, FlowNodeInput, FlowNodeOutput, FlowValidation, InlineCodeFlowNodeConfiguration, InputFlowNodeConfiguration, IteratorFlowNodeConfiguration, KnowledgeBaseDocumentDetail, KnowledgeBaseFlowNodeConfiguration, LambdaFunctionFlowNodeConfiguration, LexFlowNodeConfiguration, LoopControllerFlowNodeConfiguration, LoopInputFlowNodeConfiguration, OutputFlowNodeConfiguration, PromptFlowNodeConfiguration, PromptInferenceConfiguration, PromptTemplateConfiguration, RetrievalFlowNodeConfiguration, S3Location, ServerSideEncryptionConfiguration, StorageFlowNodeConfiguration } from "./models_0";
|
|
5
5
|
/**
|
|
6
6
|
* @public
|
|
@@ -2064,6 +2064,490 @@ export interface PutResourcePolicyResponse {
|
|
|
2064
2064
|
*/
|
|
2065
2065
|
revisionId: string | undefined;
|
|
2066
2066
|
}
|
|
2067
|
+
/**
|
|
2068
|
+
* <p>The instruction content, as a set of named fields. Every field is optional; at least one must be present. Service-side validation enforces per-field and aggregate size limits.</p>
|
|
2069
|
+
* @public
|
|
2070
|
+
*/
|
|
2071
|
+
export interface RetrievalInstructionContent {
|
|
2072
|
+
/**
|
|
2073
|
+
* <p>How to interpret and decompose the question, and what to prioritise when searching.</p>
|
|
2074
|
+
* @public
|
|
2075
|
+
*/
|
|
2076
|
+
retrievalGuidance?: string | undefined;
|
|
2077
|
+
/**
|
|
2078
|
+
* <p>Who the assistant is: identity, tone and language.</p>
|
|
2079
|
+
* @public
|
|
2080
|
+
*/
|
|
2081
|
+
persona?: string | undefined;
|
|
2082
|
+
/**
|
|
2083
|
+
* <p>How the answer is structured, including how sources are cited.</p>
|
|
2084
|
+
* @public
|
|
2085
|
+
*/
|
|
2086
|
+
answerFormat?: string | undefined;
|
|
2087
|
+
/**
|
|
2088
|
+
* <p>Whether and how to answer: how strongly an answer must be supported, and what to do with questions outside scope.</p>
|
|
2089
|
+
* @public
|
|
2090
|
+
*/
|
|
2091
|
+
answerPolicy?: string | undefined;
|
|
2092
|
+
}
|
|
2093
|
+
/**
|
|
2094
|
+
* @public
|
|
2095
|
+
*/
|
|
2096
|
+
export interface CreateRetrievalInstructionRequest {
|
|
2097
|
+
/**
|
|
2098
|
+
* <p>A caller-supplied token that makes a retried create return the existing resource rather than a second one. The window is 8 hours.</p>
|
|
2099
|
+
* @public
|
|
2100
|
+
*/
|
|
2101
|
+
clientToken?: string | undefined;
|
|
2102
|
+
/**
|
|
2103
|
+
* <p>Specifies the name of the retrieval instruction.</p>
|
|
2104
|
+
* @public
|
|
2105
|
+
*/
|
|
2106
|
+
name: string | undefined;
|
|
2107
|
+
/**
|
|
2108
|
+
* <p>The instruction content, as a set of named fields. Get does not return this field until the create review passes.</p>
|
|
2109
|
+
* @public
|
|
2110
|
+
*/
|
|
2111
|
+
instruction: RetrievalInstructionContent | undefined;
|
|
2112
|
+
/**
|
|
2113
|
+
* <p>Specifies a description of the retrieval instruction.</p>
|
|
2114
|
+
* @public
|
|
2115
|
+
*/
|
|
2116
|
+
description?: string | undefined;
|
|
2117
|
+
/**
|
|
2118
|
+
* <p>The Amazon Resource Name (ARN) of a customer managed AWS Key Management Service (AWS KMS) key used to encrypt the instruction content at rest. If you omit it, the service uses an AWS owned key. You fix the key at create and cannot change it later.</p>
|
|
2119
|
+
* @public
|
|
2120
|
+
*/
|
|
2121
|
+
customerEncryptionKeyArn?: string | undefined;
|
|
2122
|
+
/**
|
|
2123
|
+
* <p>Tags for the retrieval instruction.</p>
|
|
2124
|
+
* @public
|
|
2125
|
+
*/
|
|
2126
|
+
tags?: Record<string, string> | undefined;
|
|
2127
|
+
}
|
|
2128
|
+
/**
|
|
2129
|
+
* @public
|
|
2130
|
+
*/
|
|
2131
|
+
export interface CreateRetrievalInstructionResponse {
|
|
2132
|
+
/**
|
|
2133
|
+
* <p>The identifier of the newly created retrieval instruction.</p>
|
|
2134
|
+
* @public
|
|
2135
|
+
*/
|
|
2136
|
+
retrievalInstructionId: string | undefined;
|
|
2137
|
+
/**
|
|
2138
|
+
* <p>The ARN of the newly created retrieval instruction.</p>
|
|
2139
|
+
* @public
|
|
2140
|
+
*/
|
|
2141
|
+
retrievalInstructionArn: string | undefined;
|
|
2142
|
+
/**
|
|
2143
|
+
* <p>The name of the retrieval instruction.</p>
|
|
2144
|
+
* @public
|
|
2145
|
+
*/
|
|
2146
|
+
name: string | undefined;
|
|
2147
|
+
/**
|
|
2148
|
+
* <p>Always INACTIVE on this response. The content review has not run when this call returns, so the resource is not yet usable.</p>
|
|
2149
|
+
* @public
|
|
2150
|
+
*/
|
|
2151
|
+
status: RetrievalInstructionStatus | undefined;
|
|
2152
|
+
/**
|
|
2153
|
+
* <p>Always CREATING on this response. Poll GetRetrievalInstruction until this member is neither CREATING nor UPDATING, then read the outcome from it.</p>
|
|
2154
|
+
* @public
|
|
2155
|
+
*/
|
|
2156
|
+
lastTransitionStatus: RetrievalInstructionLastTransitionStatus | undefined;
|
|
2157
|
+
/**
|
|
2158
|
+
* <p>When you created the retrieval instruction.</p>
|
|
2159
|
+
* @public
|
|
2160
|
+
*/
|
|
2161
|
+
createdAt: Date | undefined;
|
|
2162
|
+
/**
|
|
2163
|
+
* <p>When the retrieval instruction was last updated.</p>
|
|
2164
|
+
* @public
|
|
2165
|
+
*/
|
|
2166
|
+
updatedAt: Date | undefined;
|
|
2167
|
+
}
|
|
2168
|
+
/**
|
|
2169
|
+
* @public
|
|
2170
|
+
*/
|
|
2171
|
+
export interface CreateRetrievalInstructionVersionRequest {
|
|
2172
|
+
/**
|
|
2173
|
+
* <p>The identifier of the retrieval instruction to version.</p>
|
|
2174
|
+
* @public
|
|
2175
|
+
*/
|
|
2176
|
+
retrievalInstructionId: string | undefined;
|
|
2177
|
+
/**
|
|
2178
|
+
* <p>A description of this version. Independent of the retrieval instruction's own description.</p>
|
|
2179
|
+
* @public
|
|
2180
|
+
*/
|
|
2181
|
+
description?: string | undefined;
|
|
2182
|
+
/**
|
|
2183
|
+
* <p>A caller-supplied token that makes a retried call return the version created by the first call rather than a second version. The window is 8 hours.</p>
|
|
2184
|
+
* @public
|
|
2185
|
+
*/
|
|
2186
|
+
clientToken?: string | undefined;
|
|
2187
|
+
}
|
|
2188
|
+
/**
|
|
2189
|
+
* @public
|
|
2190
|
+
*/
|
|
2191
|
+
export interface CreateRetrievalInstructionVersionResponse {
|
|
2192
|
+
/**
|
|
2193
|
+
* <p>The identifier of the retrieval instruction.</p>
|
|
2194
|
+
* @public
|
|
2195
|
+
*/
|
|
2196
|
+
retrievalInstructionId: string | undefined;
|
|
2197
|
+
/**
|
|
2198
|
+
* <p>The ARN of the retrieval instruction. Versions do not have their own ARN.</p>
|
|
2199
|
+
* @public
|
|
2200
|
+
*/
|
|
2201
|
+
retrievalInstructionArn: string | undefined;
|
|
2202
|
+
/**
|
|
2203
|
+
* <p>The number of the version created. Versions are numbered from 1 and allocated monotonically; a number is never reused, even after the version is deleted.</p>
|
|
2204
|
+
* @public
|
|
2205
|
+
*/
|
|
2206
|
+
version: string | undefined;
|
|
2207
|
+
/**
|
|
2208
|
+
* <p>When this version was created.</p>
|
|
2209
|
+
* @public
|
|
2210
|
+
*/
|
|
2211
|
+
createdAt: Date | undefined;
|
|
2212
|
+
/**
|
|
2213
|
+
* <p>The description of this version, when one was supplied.</p>
|
|
2214
|
+
* @public
|
|
2215
|
+
*/
|
|
2216
|
+
description?: string | undefined;
|
|
2217
|
+
}
|
|
2218
|
+
/**
|
|
2219
|
+
* @public
|
|
2220
|
+
*/
|
|
2221
|
+
export interface DeleteRetrievalInstructionRequest {
|
|
2222
|
+
/**
|
|
2223
|
+
* <p>The identifier of the retrieval instruction to delete.</p>
|
|
2224
|
+
* @public
|
|
2225
|
+
*/
|
|
2226
|
+
retrievalInstructionId: string | undefined;
|
|
2227
|
+
/**
|
|
2228
|
+
* <p>The version to delete. Omit this field to delete the retrieval instruction itself, which you can do only when it has no versions; while any version exists the service rejects the request with ConflictException. You cannot delete DRAFT on its own; deleting the retrieval instruction removes it.</p>
|
|
2229
|
+
* @public
|
|
2230
|
+
*/
|
|
2231
|
+
retrievalInstructionVersion?: string | undefined;
|
|
2232
|
+
}
|
|
2233
|
+
/**
|
|
2234
|
+
* @public
|
|
2235
|
+
*/
|
|
2236
|
+
export interface DeleteRetrievalInstructionResponse {
|
|
2237
|
+
/**
|
|
2238
|
+
* <p>The identifier of the deleted retrieval instruction.</p>
|
|
2239
|
+
* @public
|
|
2240
|
+
*/
|
|
2241
|
+
retrievalInstructionId: string | undefined;
|
|
2242
|
+
/**
|
|
2243
|
+
* <p>The ARN of the retrieval instruction.</p>
|
|
2244
|
+
* @public
|
|
2245
|
+
*/
|
|
2246
|
+
retrievalInstructionArn: string | undefined;
|
|
2247
|
+
/**
|
|
2248
|
+
* <p>The version that you deleted. Absent when you deleted the whole retrieval instruction.</p>
|
|
2249
|
+
* @public
|
|
2250
|
+
*/
|
|
2251
|
+
version?: string | undefined;
|
|
2252
|
+
}
|
|
2253
|
+
/**
|
|
2254
|
+
* @public
|
|
2255
|
+
*/
|
|
2256
|
+
export interface GetRetrievalInstructionRequest {
|
|
2257
|
+
/**
|
|
2258
|
+
* <p>The identifier of the retrieval instruction to get.</p>
|
|
2259
|
+
* @public
|
|
2260
|
+
*/
|
|
2261
|
+
retrievalInstructionId: string | undefined;
|
|
2262
|
+
/**
|
|
2263
|
+
* <p>The version to return: a version number, or DRAFT for the retrieval instruction's current reviewed content. When omitted, DRAFT is used. This default is permanent: omitting retrievalInstructionVersion will never resolve to a numbered version.</p>
|
|
2264
|
+
* @public
|
|
2265
|
+
*/
|
|
2266
|
+
retrievalInstructionVersion?: string | undefined;
|
|
2267
|
+
}
|
|
2268
|
+
/**
|
|
2269
|
+
* <p>One reason the most recent create or update did not succeed. code drives programmatic branching (fix the text, fix the configuration, or retry); message carries the specific cause.</p>
|
|
2270
|
+
* @public
|
|
2271
|
+
*/
|
|
2272
|
+
export interface RetrievalInstructionFailureReason {
|
|
2273
|
+
/**
|
|
2274
|
+
* <p>The instruction field this entry is about. Present on review rejections of a specific field; absent when the failure applies to the whole review, because a client-side execution failure or a service fault has no single field.</p>
|
|
2275
|
+
* @public
|
|
2276
|
+
*/
|
|
2277
|
+
fieldName?: RetrievalInstructionFieldName | undefined;
|
|
2278
|
+
/**
|
|
2279
|
+
* <p>Stable, machine-readable classification by fault attribution. Valid values:</p> <ul> <li> <p>CONTENT_REJECTED – The review rejected the named field's content; revise the text and resubmit.</p> </li> <li> <p>CLIENT_ERROR – The review could not run for a customer-side reason, for example the customer managed AWS KMS key could not be used; fix the configuration and resubmit.</p> </li> <li> <p>INTERNAL_ERROR – The review could not complete due to a service fault; retry the create or update.</p> </li> </ul> <p>New values may be added over time; your client should tolerate values it does not recognize and treat them as a failure.</p>
|
|
2280
|
+
* @public
|
|
2281
|
+
*/
|
|
2282
|
+
code: RetrievalInstructionFailureReasonCode | undefined;
|
|
2283
|
+
/**
|
|
2284
|
+
* <p>Human-readable explanation of the specific cause. Never contains the customer's own text.</p>
|
|
2285
|
+
* @public
|
|
2286
|
+
*/
|
|
2287
|
+
message: string | undefined;
|
|
2288
|
+
}
|
|
2289
|
+
/**
|
|
2290
|
+
* @public
|
|
2291
|
+
*/
|
|
2292
|
+
export interface GetRetrievalInstructionResponse {
|
|
2293
|
+
/**
|
|
2294
|
+
* <p>The identifier of the retrieval instruction.</p>
|
|
2295
|
+
* @public
|
|
2296
|
+
*/
|
|
2297
|
+
retrievalInstructionId: string | undefined;
|
|
2298
|
+
/**
|
|
2299
|
+
* <p>The ARN of the retrieval instruction.</p>
|
|
2300
|
+
* @public
|
|
2301
|
+
*/
|
|
2302
|
+
retrievalInstructionArn: string | undefined;
|
|
2303
|
+
/**
|
|
2304
|
+
* <p>The name of the retrieval instruction.</p>
|
|
2305
|
+
* @public
|
|
2306
|
+
*/
|
|
2307
|
+
name: string | undefined;
|
|
2308
|
+
/**
|
|
2309
|
+
* <p>Specifies whether you can use the instruction. You can resolve only an ACTIVE instruction at retrieval time. Monotone: INACTIVE to ACTIVE once, never back. Numbered versions are always ACTIVE.</p>
|
|
2310
|
+
* @public
|
|
2311
|
+
*/
|
|
2312
|
+
status: RetrievalInstructionStatus | undefined;
|
|
2313
|
+
/**
|
|
2314
|
+
* <p>The outcome or in-progress state of the most recent create or update. CREATING or UPDATING means the operation is still running. Independent of status. Always has a value from the create 202 onward. On a numbered version this is always CREATE_SUCCESSFUL: a version is created once, from reviewed content, and is immutable.</p>
|
|
2315
|
+
* @public
|
|
2316
|
+
*/
|
|
2317
|
+
lastTransitionStatus: RetrievalInstructionLastTransitionStatus | undefined;
|
|
2318
|
+
/**
|
|
2319
|
+
* <p>The reviewed content this instruction serves — what AgenticRetrieveStream resolves while status is ACTIVE. Absent until the first create review passes. Always present on a numbered version.</p>
|
|
2320
|
+
* @public
|
|
2321
|
+
*/
|
|
2322
|
+
instruction?: RetrievalInstructionContent | undefined;
|
|
2323
|
+
/**
|
|
2324
|
+
* <p>When the retrieval instruction was created. On a numbered version, when that version was created.</p>
|
|
2325
|
+
* @public
|
|
2326
|
+
*/
|
|
2327
|
+
createdAt: Date | undefined;
|
|
2328
|
+
/**
|
|
2329
|
+
* <p>When the retrieval instruction was last updated. Equal to createdAt on a numbered version, which is immutable.</p>
|
|
2330
|
+
* @public
|
|
2331
|
+
*/
|
|
2332
|
+
updatedAt: Date | undefined;
|
|
2333
|
+
/**
|
|
2334
|
+
* <p>A description of the retrieval instruction. On a numbered version, the description of that version.</p>
|
|
2335
|
+
* @public
|
|
2336
|
+
*/
|
|
2337
|
+
description?: string | undefined;
|
|
2338
|
+
/**
|
|
2339
|
+
* <p>The ARN of the customer managed KMS key protecting this content, when one was supplied at create.</p>
|
|
2340
|
+
* @public
|
|
2341
|
+
*/
|
|
2342
|
+
customerEncryptionKeyArn?: string | undefined;
|
|
2343
|
+
/**
|
|
2344
|
+
* <p>Why the most recent create or update was rejected. One entry for each rejected field, or a single entry when the review itself failed. Each entry has a machine-readable code and a message, and names the field when it applies to one. The service includes this field only when lastTransitionStatus is CREATE_FAILED or UPDATE_FAILED. Never present on a numbered version.</p>
|
|
2345
|
+
* @public
|
|
2346
|
+
*/
|
|
2347
|
+
lastTransitionStatusReasons?: RetrievalInstructionFailureReason[] | undefined;
|
|
2348
|
+
/**
|
|
2349
|
+
* <p>The version this response describes: a version number, or DRAFT.</p>
|
|
2350
|
+
* @public
|
|
2351
|
+
*/
|
|
2352
|
+
version?: string | undefined;
|
|
2353
|
+
/**
|
|
2354
|
+
* <p>The largest version number that currently exists for this retrieval instruction, that is, the newest version you can retrieve. Present only on a DRAFT read, and only when at least one version exists. Because version numbers are never reused, deleting versions can leave gaps: this is the newest existing version, not a count and not the highest number ever created.</p>
|
|
2355
|
+
* @public
|
|
2356
|
+
*/
|
|
2357
|
+
latestVersion?: string | undefined;
|
|
2358
|
+
}
|
|
2359
|
+
/**
|
|
2360
|
+
* @public
|
|
2361
|
+
*/
|
|
2362
|
+
export interface ListRetrievalInstructionsRequest {
|
|
2363
|
+
/**
|
|
2364
|
+
* <p>Return only instructions with this availability status.</p>
|
|
2365
|
+
* @public
|
|
2366
|
+
*/
|
|
2367
|
+
status?: RetrievalInstructionStatus | undefined;
|
|
2368
|
+
/**
|
|
2369
|
+
* <p>The maximum number of results to return in a single page. The effective upper bound is enforced service-side.</p>
|
|
2370
|
+
* @public
|
|
2371
|
+
*/
|
|
2372
|
+
maxResults?: number | undefined;
|
|
2373
|
+
/**
|
|
2374
|
+
* <p>The pagination token from a previous ListRetrievalInstructions response.</p>
|
|
2375
|
+
* @public
|
|
2376
|
+
*/
|
|
2377
|
+
nextToken?: string | undefined;
|
|
2378
|
+
}
|
|
2379
|
+
/**
|
|
2380
|
+
* <p>A summary of a retrieval instruction, without the content.</p>
|
|
2381
|
+
* @public
|
|
2382
|
+
*/
|
|
2383
|
+
export interface RetrievalInstructionSummary {
|
|
2384
|
+
/**
|
|
2385
|
+
* <p>The identifier of the retrieval instruction.</p>
|
|
2386
|
+
* @public
|
|
2387
|
+
*/
|
|
2388
|
+
retrievalInstructionId: string | undefined;
|
|
2389
|
+
/**
|
|
2390
|
+
* <p>The ARN of the retrieval instruction.</p>
|
|
2391
|
+
* @public
|
|
2392
|
+
*/
|
|
2393
|
+
retrievalInstructionArn: string | undefined;
|
|
2394
|
+
/**
|
|
2395
|
+
* <p>The name of the retrieval instruction.</p>
|
|
2396
|
+
* @public
|
|
2397
|
+
*/
|
|
2398
|
+
name: string | undefined;
|
|
2399
|
+
/**
|
|
2400
|
+
* <p>Whether the instruction can be used. Only ACTIVE is resolvable at retrieval time.</p>
|
|
2401
|
+
* @public
|
|
2402
|
+
*/
|
|
2403
|
+
status: RetrievalInstructionStatus | undefined;
|
|
2404
|
+
/**
|
|
2405
|
+
* <p>The outcome or in-progress state of the most recent create or update of the retrieval instruction.</p>
|
|
2406
|
+
* @public
|
|
2407
|
+
*/
|
|
2408
|
+
lastTransitionStatus: RetrievalInstructionLastTransitionStatus | undefined;
|
|
2409
|
+
/**
|
|
2410
|
+
* <p>When you created the retrieval instruction.</p>
|
|
2411
|
+
* @public
|
|
2412
|
+
*/
|
|
2413
|
+
createdAt: Date | undefined;
|
|
2414
|
+
/**
|
|
2415
|
+
* <p>When the retrieval instruction was last updated.</p>
|
|
2416
|
+
* @public
|
|
2417
|
+
*/
|
|
2418
|
+
updatedAt: Date | undefined;
|
|
2419
|
+
/**
|
|
2420
|
+
* <p>A description of the retrieval instruction.</p>
|
|
2421
|
+
* @public
|
|
2422
|
+
*/
|
|
2423
|
+
description?: string | undefined;
|
|
2424
|
+
}
|
|
2425
|
+
/**
|
|
2426
|
+
* @public
|
|
2427
|
+
*/
|
|
2428
|
+
export interface ListRetrievalInstructionsResponse {
|
|
2429
|
+
/**
|
|
2430
|
+
* <p>The retrieval instruction summaries in this page.</p>
|
|
2431
|
+
* @public
|
|
2432
|
+
*/
|
|
2433
|
+
retrievalInstructionSummaries: RetrievalInstructionSummary[] | undefined;
|
|
2434
|
+
/**
|
|
2435
|
+
* <p>The pagination token to pass to the next ListRetrievalInstructions call, absent on the last page.</p>
|
|
2436
|
+
* @public
|
|
2437
|
+
*/
|
|
2438
|
+
nextToken?: string | undefined;
|
|
2439
|
+
}
|
|
2440
|
+
/**
|
|
2441
|
+
* @public
|
|
2442
|
+
*/
|
|
2443
|
+
export interface ListRetrievalInstructionVersionsRequest {
|
|
2444
|
+
/**
|
|
2445
|
+
* <p>The identifier of the retrieval instruction whose versions to list.</p>
|
|
2446
|
+
* @public
|
|
2447
|
+
*/
|
|
2448
|
+
retrievalInstructionId: string | undefined;
|
|
2449
|
+
/**
|
|
2450
|
+
* <p>Specifies the maximum number of versions to return in a single page. The service enforces the effective upper bound.</p>
|
|
2451
|
+
* @public
|
|
2452
|
+
*/
|
|
2453
|
+
maxResults?: number | undefined;
|
|
2454
|
+
/**
|
|
2455
|
+
* <p>The pagination token from a previous ListRetrievalInstructionVersions response.</p>
|
|
2456
|
+
* @public
|
|
2457
|
+
*/
|
|
2458
|
+
nextToken?: string | undefined;
|
|
2459
|
+
}
|
|
2460
|
+
/**
|
|
2461
|
+
* <p>A summary of one numbered version of a retrieval instruction, without the content.</p>
|
|
2462
|
+
* @public
|
|
2463
|
+
*/
|
|
2464
|
+
export interface RetrievalInstructionVersionSummary {
|
|
2465
|
+
/**
|
|
2466
|
+
* <p>The version number.</p>
|
|
2467
|
+
* @public
|
|
2468
|
+
*/
|
|
2469
|
+
version: string | undefined;
|
|
2470
|
+
/**
|
|
2471
|
+
* <p>When this version was created.</p>
|
|
2472
|
+
* @public
|
|
2473
|
+
*/
|
|
2474
|
+
createdAt: Date | undefined;
|
|
2475
|
+
}
|
|
2476
|
+
/**
|
|
2477
|
+
* @public
|
|
2478
|
+
*/
|
|
2479
|
+
export interface ListRetrievalInstructionVersionsResponse {
|
|
2480
|
+
/**
|
|
2481
|
+
* <p>The version summaries in this page, newest first.</p>
|
|
2482
|
+
* @public
|
|
2483
|
+
*/
|
|
2484
|
+
retrievalInstructionVersionSummaries: RetrievalInstructionVersionSummary[] | undefined;
|
|
2485
|
+
/**
|
|
2486
|
+
* <p>The pagination token to pass to the next ListRetrievalInstructionVersions call, absent on the last page.</p>
|
|
2487
|
+
* @public
|
|
2488
|
+
*/
|
|
2489
|
+
nextToken?: string | undefined;
|
|
2490
|
+
}
|
|
2491
|
+
/**
|
|
2492
|
+
* @public
|
|
2493
|
+
*/
|
|
2494
|
+
export interface UpdateRetrievalInstructionRequest {
|
|
2495
|
+
/**
|
|
2496
|
+
* <p>The identifier of the retrieval instruction to update.</p>
|
|
2497
|
+
* @public
|
|
2498
|
+
*/
|
|
2499
|
+
retrievalInstructionId: string | undefined;
|
|
2500
|
+
/**
|
|
2501
|
+
* <p>The replacement instruction content. This is a full replacement of all four fields, not a patch. During UPDATING, Get continues to return the previously-served content until the update review passes.</p>
|
|
2502
|
+
* @public
|
|
2503
|
+
*/
|
|
2504
|
+
instruction: RetrievalInstructionContent | undefined;
|
|
2505
|
+
/**
|
|
2506
|
+
* <p>A replacement description; applied together with the content when the review passes. Omit to clear.</p>
|
|
2507
|
+
* @public
|
|
2508
|
+
*/
|
|
2509
|
+
description?: string | undefined;
|
|
2510
|
+
}
|
|
2511
|
+
/**
|
|
2512
|
+
* @public
|
|
2513
|
+
*/
|
|
2514
|
+
export interface UpdateRetrievalInstructionResponse {
|
|
2515
|
+
/**
|
|
2516
|
+
* <p>The identifier of the retrieval instruction.</p>
|
|
2517
|
+
* @public
|
|
2518
|
+
*/
|
|
2519
|
+
retrievalInstructionId: string | undefined;
|
|
2520
|
+
/**
|
|
2521
|
+
* <p>The ARN of the retrieval instruction.</p>
|
|
2522
|
+
* @public
|
|
2523
|
+
*/
|
|
2524
|
+
retrievalInstructionArn: string | undefined;
|
|
2525
|
+
/**
|
|
2526
|
+
* <p>The name of the retrieval instruction.</p>
|
|
2527
|
+
* @public
|
|
2528
|
+
*/
|
|
2529
|
+
name: string | undefined;
|
|
2530
|
+
/**
|
|
2531
|
+
* <p>Whether the instruction can be used. An update never lowers status. Unchanged from the previous value on this response.</p>
|
|
2532
|
+
* @public
|
|
2533
|
+
*/
|
|
2534
|
+
status: RetrievalInstructionStatus | undefined;
|
|
2535
|
+
/**
|
|
2536
|
+
* <p>Always UPDATING on this response. Poll GetRetrievalInstruction until this member is neither CREATING nor UPDATING, then read the outcome from it.</p>
|
|
2537
|
+
* @public
|
|
2538
|
+
*/
|
|
2539
|
+
lastTransitionStatus: RetrievalInstructionLastTransitionStatus | undefined;
|
|
2540
|
+
/**
|
|
2541
|
+
* <p>When you created the retrieval instruction.</p>
|
|
2542
|
+
* @public
|
|
2543
|
+
*/
|
|
2544
|
+
createdAt: Date | undefined;
|
|
2545
|
+
/**
|
|
2546
|
+
* <p>When the retrieval instruction was last updated.</p>
|
|
2547
|
+
* @public
|
|
2548
|
+
*/
|
|
2549
|
+
updatedAt: Date | undefined;
|
|
2550
|
+
}
|
|
2067
2551
|
/**
|
|
2068
2552
|
* @public
|
|
2069
2553
|
*/
|
|
@@ -0,0 +1,7 @@
|
|
|
1
|
+
import type { Paginator } from "@smithy/types";
|
|
2
|
+
import { ListRetrievalInstructionVersionsCommandInput, ListRetrievalInstructionVersionsCommandOutput } from "../commands/ListRetrievalInstructionVersionsCommand";
|
|
3
|
+
import type { BedrockAgentPaginationConfiguration } from "./Interfaces";
|
|
4
|
+
/**
|
|
5
|
+
* @public
|
|
6
|
+
*/
|
|
7
|
+
export declare const paginateListRetrievalInstructionVersions: (config: BedrockAgentPaginationConfiguration, input: ListRetrievalInstructionVersionsCommandInput, ...rest: any[]) => Paginator<ListRetrievalInstructionVersionsCommandOutput>;
|
|
@@ -0,0 +1,7 @@
|
|
|
1
|
+
import type { Paginator } from "@smithy/types";
|
|
2
|
+
import { ListRetrievalInstructionsCommandInput, ListRetrievalInstructionsCommandOutput } from "../commands/ListRetrievalInstructionsCommand";
|
|
3
|
+
import type { BedrockAgentPaginationConfiguration } from "./Interfaces";
|
|
4
|
+
/**
|
|
5
|
+
* @public
|
|
6
|
+
*/
|
|
7
|
+
export declare const paginateListRetrievalInstructions: (config: BedrockAgentPaginationConfiguration, input: ListRetrievalInstructionsCommandInput, ...rest: any[]) => Paginator<ListRetrievalInstructionsCommandOutput>;
|
|
@@ -13,4 +13,6 @@ export * from "./ListIngestionJobsPaginator";
|
|
|
13
13
|
export * from "./ListKnowledgeBaseDocumentsPaginator";
|
|
14
14
|
export * from "./ListKnowledgeBasesPaginator";
|
|
15
15
|
export * from "./ListPromptsPaginator";
|
|
16
|
+
export * from "./ListRetrievalInstructionsPaginator";
|
|
17
|
+
export * from "./ListRetrievalInstructionVersionsPaginator";
|
|
16
18
|
export * from "./ListVpcConfigurationsPaginator";
|
|
@@ -74,6 +74,10 @@ export declare var CreatePromptRequest$: StaticStructureSchema;
|
|
|
74
74
|
export declare var CreatePromptResponse$: StaticStructureSchema;
|
|
75
75
|
export declare var CreatePromptVersionRequest$: StaticStructureSchema;
|
|
76
76
|
export declare var CreatePromptVersionResponse$: StaticStructureSchema;
|
|
77
|
+
export declare var CreateRetrievalInstructionRequest$: StaticStructureSchema;
|
|
78
|
+
export declare var CreateRetrievalInstructionResponse$: StaticStructureSchema;
|
|
79
|
+
export declare var CreateRetrievalInstructionVersionRequest$: StaticStructureSchema;
|
|
80
|
+
export declare var CreateRetrievalInstructionVersionResponse$: StaticStructureSchema;
|
|
77
81
|
export declare var CreateVpcConfigurationRequest$: StaticStructureSchema;
|
|
78
82
|
export declare var CreateVpcConfigurationResponse$: StaticStructureSchema;
|
|
79
83
|
export declare var CuratedQuery$: StaticStructureSchema;
|
|
@@ -111,6 +115,8 @@ export declare var DeletePromptRequest$: StaticStructureSchema;
|
|
|
111
115
|
export declare var DeletePromptResponse$: StaticStructureSchema;
|
|
112
116
|
export declare var DeleteResourcePolicyRequest$: StaticStructureSchema;
|
|
113
117
|
export declare var DeleteResourcePolicyResponse$: StaticStructureSchema;
|
|
118
|
+
export declare var DeleteRetrievalInstructionRequest$: StaticStructureSchema;
|
|
119
|
+
export declare var DeleteRetrievalInstructionResponse$: StaticStructureSchema;
|
|
114
120
|
export declare var DeleteVpcConfigurationRequest$: StaticStructureSchema;
|
|
115
121
|
export declare var DeleteVpcConfigurationResponse$: StaticStructureSchema;
|
|
116
122
|
export declare var DeletionProtectionConfiguration$: StaticStructureSchema;
|
|
@@ -173,6 +179,8 @@ export declare var GetPromptRequest$: StaticStructureSchema;
|
|
|
173
179
|
export declare var GetPromptResponse$: StaticStructureSchema;
|
|
174
180
|
export declare var GetResourcePolicyRequest$: StaticStructureSchema;
|
|
175
181
|
export declare var GetResourcePolicyResponse$: StaticStructureSchema;
|
|
182
|
+
export declare var GetRetrievalInstructionRequest$: StaticStructureSchema;
|
|
183
|
+
export declare var GetRetrievalInstructionResponse$: StaticStructureSchema;
|
|
176
184
|
export declare var GetVpcConfigurationRequest$: StaticStructureSchema;
|
|
177
185
|
export declare var GetVpcConfigurationResponse$: StaticStructureSchema;
|
|
178
186
|
export declare var GuardrailConfiguration$: StaticStructureSchema;
|
|
@@ -234,6 +242,10 @@ export declare var ListKnowledgeBasesRequest$: StaticStructureSchema;
|
|
|
234
242
|
export declare var ListKnowledgeBasesResponse$: StaticStructureSchema;
|
|
235
243
|
export declare var ListPromptsRequest$: StaticStructureSchema;
|
|
236
244
|
export declare var ListPromptsResponse$: StaticStructureSchema;
|
|
245
|
+
export declare var ListRetrievalInstructionsRequest$: StaticStructureSchema;
|
|
246
|
+
export declare var ListRetrievalInstructionsResponse$: StaticStructureSchema;
|
|
247
|
+
export declare var ListRetrievalInstructionVersionsRequest$: StaticStructureSchema;
|
|
248
|
+
export declare var ListRetrievalInstructionVersionsResponse$: StaticStructureSchema;
|
|
237
249
|
export declare var ListTagsForResourceRequest$: StaticStructureSchema;
|
|
238
250
|
export declare var ListTagsForResourceResponse$: StaticStructureSchema;
|
|
239
251
|
export declare var ListVpcConfigurationsRequest$: StaticStructureSchema;
|
|
@@ -320,6 +332,10 @@ export declare var RedshiftServerlessAuthConfiguration$: StaticStructureSchema;
|
|
|
320
332
|
export declare var RedshiftServerlessConfiguration$: StaticStructureSchema;
|
|
321
333
|
export declare var RetrievalFlowNodeConfiguration$: StaticStructureSchema;
|
|
322
334
|
export declare var RetrievalFlowNodeS3Configuration$: StaticStructureSchema;
|
|
335
|
+
export declare var RetrievalInstructionContent$: StaticStructureSchema;
|
|
336
|
+
export declare var RetrievalInstructionFailureReason$: StaticStructureSchema;
|
|
337
|
+
export declare var RetrievalInstructionSummary$: StaticStructureSchema;
|
|
338
|
+
export declare var RetrievalInstructionVersionSummary$: StaticStructureSchema;
|
|
323
339
|
export declare var S3Content$: StaticStructureSchema;
|
|
324
340
|
export declare var S3DataSourceConfiguration$: StaticStructureSchema;
|
|
325
341
|
export declare var S3Identifier$: StaticStructureSchema;
|
|
@@ -388,6 +404,8 @@ export declare var UpdateKnowledgeBaseRequest$: StaticStructureSchema;
|
|
|
388
404
|
export declare var UpdateKnowledgeBaseResponse$: StaticStructureSchema;
|
|
389
405
|
export declare var UpdatePromptRequest$: StaticStructureSchema;
|
|
390
406
|
export declare var UpdatePromptResponse$: StaticStructureSchema;
|
|
407
|
+
export declare var UpdateRetrievalInstructionRequest$: StaticStructureSchema;
|
|
408
|
+
export declare var UpdateRetrievalInstructionResponse$: StaticStructureSchema;
|
|
391
409
|
export declare var UrlConfiguration$: StaticStructureSchema;
|
|
392
410
|
export declare var ValidateFlowDefinitionRequest$: StaticStructureSchema;
|
|
393
411
|
export declare var ValidateFlowDefinitionResponse$: StaticStructureSchema;
|
|
@@ -440,6 +458,8 @@ export declare var CreateFlowVersion$: StaticOperationSchema;
|
|
|
440
458
|
export declare var CreateKnowledgeBase$: StaticOperationSchema;
|
|
441
459
|
export declare var CreatePrompt$: StaticOperationSchema;
|
|
442
460
|
export declare var CreatePromptVersion$: StaticOperationSchema;
|
|
461
|
+
export declare var CreateRetrievalInstruction$: StaticOperationSchema;
|
|
462
|
+
export declare var CreateRetrievalInstructionVersion$: StaticOperationSchema;
|
|
443
463
|
export declare var CreateVpcConfiguration$: StaticOperationSchema;
|
|
444
464
|
export declare var DeleteAgent$: StaticOperationSchema;
|
|
445
465
|
export declare var DeleteAgentActionGroup$: StaticOperationSchema;
|
|
@@ -453,6 +473,7 @@ export declare var DeleteKnowledgeBase$: StaticOperationSchema;
|
|
|
453
473
|
export declare var DeleteKnowledgeBaseDocuments$: StaticOperationSchema;
|
|
454
474
|
export declare var DeletePrompt$: StaticOperationSchema;
|
|
455
475
|
export declare var DeleteResourcePolicy$: StaticOperationSchema;
|
|
476
|
+
export declare var DeleteRetrievalInstruction$: StaticOperationSchema;
|
|
456
477
|
export declare var DeleteVpcConfiguration$: StaticOperationSchema;
|
|
457
478
|
export declare var DisassociateAgentCollaborator$: StaticOperationSchema;
|
|
458
479
|
export declare var DisassociateAgentKnowledgeBase$: StaticOperationSchema;
|
|
@@ -471,6 +492,7 @@ export declare var GetKnowledgeBase$: StaticOperationSchema;
|
|
|
471
492
|
export declare var GetKnowledgeBaseDocuments$: StaticOperationSchema;
|
|
472
493
|
export declare var GetPrompt$: StaticOperationSchema;
|
|
473
494
|
export declare var GetResourcePolicy$: StaticOperationSchema;
|
|
495
|
+
export declare var GetRetrievalInstruction$: StaticOperationSchema;
|
|
474
496
|
export declare var GetVpcConfiguration$: StaticOperationSchema;
|
|
475
497
|
export declare var IngestKnowledgeBaseDocuments$: StaticOperationSchema;
|
|
476
498
|
export declare var ListAgentActionGroups$: StaticOperationSchema;
|
|
@@ -487,6 +509,8 @@ export declare var ListIngestionJobs$: StaticOperationSchema;
|
|
|
487
509
|
export declare var ListKnowledgeBaseDocuments$: StaticOperationSchema;
|
|
488
510
|
export declare var ListKnowledgeBases$: StaticOperationSchema;
|
|
489
511
|
export declare var ListPrompts$: StaticOperationSchema;
|
|
512
|
+
export declare var ListRetrievalInstructions$: StaticOperationSchema;
|
|
513
|
+
export declare var ListRetrievalInstructionVersions$: StaticOperationSchema;
|
|
490
514
|
export declare var ListTagsForResource$: StaticOperationSchema;
|
|
491
515
|
export declare var ListVpcConfigurations$: StaticOperationSchema;
|
|
492
516
|
export declare var PrepareAgent$: StaticOperationSchema;
|
|
@@ -506,4 +530,5 @@ export declare var UpdateFlow$: StaticOperationSchema;
|
|
|
506
530
|
export declare var UpdateFlowAlias$: StaticOperationSchema;
|
|
507
531
|
export declare var UpdateKnowledgeBase$: StaticOperationSchema;
|
|
508
532
|
export declare var UpdatePrompt$: StaticOperationSchema;
|
|
533
|
+
export declare var UpdateRetrievalInstruction$: StaticOperationSchema;
|
|
509
534
|
export declare var ValidateFlowDefinition$: StaticOperationSchema;
|