@aws-sdk/client-bedrock-agent-runtime 3.701.0 → 3.703.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 +16 -0
- package/dist-cjs/index.js +530 -3
- package/dist-es/BedrockAgentRuntime.js +4 -0
- package/dist-es/commands/RerankCommand.js +23 -0
- package/dist-es/commands/RetrieveAndGenerateStreamCommand.js +27 -0
- package/dist-es/commands/index.js +2 -0
- package/dist-es/models/models_0.js +180 -0
- package/dist-es/pagination/RerankPaginator.js +4 -0
- package/dist-es/pagination/index.js +1 -0
- package/dist-es/protocols/Aws_restJson1.js +231 -0
- package/dist-types/BedrockAgentRuntime.d.ts +14 -0
- package/dist-types/BedrockAgentRuntimeClient.d.ts +4 -2
- package/dist-types/commands/InvokeAgentCommand.d.ts +45 -2
- package/dist-types/commands/InvokeInlineAgentCommand.d.ts +45 -2
- package/dist-types/commands/RerankCommand.d.ts +143 -0
- package/dist-types/commands/RetrieveAndGenerateCommand.d.ts +42 -2
- package/dist-types/commands/RetrieveAndGenerateStreamCommand.d.ts +371 -0
- package/dist-types/commands/RetrieveCommand.d.ts +46 -1
- package/dist-types/commands/index.d.ts +2 -0
- package/dist-types/models/models_0.d.ts +1038 -166
- package/dist-types/pagination/RerankPaginator.d.ts +7 -0
- package/dist-types/pagination/index.d.ts +1 -0
- package/dist-types/protocols/Aws_restJson1.d.ts +18 -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/RerankCommand.d.ts +41 -0
- package/dist-types/ts3.4/commands/RetrieveAndGenerateStreamCommand.d.ts +51 -0
- package/dist-types/ts3.4/commands/index.d.ts +2 -0
- package/dist-types/ts3.4/models/models_0.d.ts +455 -0
- package/dist-types/ts3.4/pagination/RerankPaginator.d.ts +11 -0
- package/dist-types/ts3.4/pagination/index.d.ts +1 -0
- package/dist-types/ts3.4/protocols/Aws_restJson1.d.ts +24 -0
- package/package.json +1 -1
|
@@ -652,11 +652,94 @@ export interface FilterAttribute {
|
|
|
652
652
|
key: string | undefined;
|
|
653
653
|
value: __DocumentType | undefined;
|
|
654
654
|
}
|
|
655
|
+
export declare const AttributeType: {
|
|
656
|
+
readonly BOOLEAN: "BOOLEAN";
|
|
657
|
+
readonly NUMBER: "NUMBER";
|
|
658
|
+
readonly STRING: "STRING";
|
|
659
|
+
readonly STRING_LIST: "STRING_LIST";
|
|
660
|
+
};
|
|
661
|
+
export type AttributeType = (typeof AttributeType)[keyof typeof AttributeType];
|
|
662
|
+
export interface MetadataAttributeSchema {
|
|
663
|
+
key: string | undefined;
|
|
664
|
+
type: AttributeType | undefined;
|
|
665
|
+
description: string | undefined;
|
|
666
|
+
}
|
|
667
|
+
export interface ImplicitFilterConfiguration {
|
|
668
|
+
metadataAttributes: MetadataAttributeSchema[] | undefined;
|
|
669
|
+
modelArn: string | undefined;
|
|
670
|
+
}
|
|
655
671
|
export declare const SearchType: {
|
|
656
672
|
readonly HYBRID: "HYBRID";
|
|
657
673
|
readonly SEMANTIC: "SEMANTIC";
|
|
658
674
|
};
|
|
659
675
|
export type SearchType = (typeof SearchType)[keyof typeof SearchType];
|
|
676
|
+
export declare const RerankingMetadataSelectionMode: {
|
|
677
|
+
readonly ALL: "ALL";
|
|
678
|
+
readonly SELECTIVE: "SELECTIVE";
|
|
679
|
+
};
|
|
680
|
+
export type RerankingMetadataSelectionMode =
|
|
681
|
+
(typeof RerankingMetadataSelectionMode)[keyof typeof RerankingMetadataSelectionMode];
|
|
682
|
+
export interface FieldForReranking {
|
|
683
|
+
fieldName: string | undefined;
|
|
684
|
+
}
|
|
685
|
+
export type RerankingMetadataSelectiveModeConfiguration =
|
|
686
|
+
| RerankingMetadataSelectiveModeConfiguration.FieldsToExcludeMember
|
|
687
|
+
| RerankingMetadataSelectiveModeConfiguration.FieldsToIncludeMember
|
|
688
|
+
| RerankingMetadataSelectiveModeConfiguration.$UnknownMember;
|
|
689
|
+
export declare namespace RerankingMetadataSelectiveModeConfiguration {
|
|
690
|
+
interface FieldsToIncludeMember {
|
|
691
|
+
fieldsToInclude: FieldForReranking[];
|
|
692
|
+
fieldsToExclude?: never;
|
|
693
|
+
$unknown?: never;
|
|
694
|
+
}
|
|
695
|
+
interface FieldsToExcludeMember {
|
|
696
|
+
fieldsToInclude?: never;
|
|
697
|
+
fieldsToExclude: FieldForReranking[];
|
|
698
|
+
$unknown?: never;
|
|
699
|
+
}
|
|
700
|
+
interface $UnknownMember {
|
|
701
|
+
fieldsToInclude?: never;
|
|
702
|
+
fieldsToExclude?: never;
|
|
703
|
+
$unknown: [string, any];
|
|
704
|
+
}
|
|
705
|
+
interface Visitor<T> {
|
|
706
|
+
fieldsToInclude: (value: FieldForReranking[]) => T;
|
|
707
|
+
fieldsToExclude: (value: FieldForReranking[]) => T;
|
|
708
|
+
_: (name: string, value: any) => T;
|
|
709
|
+
}
|
|
710
|
+
const visit: <T>(
|
|
711
|
+
value: RerankingMetadataSelectiveModeConfiguration,
|
|
712
|
+
visitor: Visitor<T>
|
|
713
|
+
) => T;
|
|
714
|
+
}
|
|
715
|
+
export interface MetadataConfigurationForReranking {
|
|
716
|
+
selectionMode: RerankingMetadataSelectionMode | undefined;
|
|
717
|
+
selectiveModeConfiguration?:
|
|
718
|
+
| RerankingMetadataSelectiveModeConfiguration
|
|
719
|
+
| undefined;
|
|
720
|
+
}
|
|
721
|
+
export interface VectorSearchBedrockRerankingModelConfiguration {
|
|
722
|
+
modelArn: string | undefined;
|
|
723
|
+
additionalModelRequestFields?: Record<string, __DocumentType> | undefined;
|
|
724
|
+
}
|
|
725
|
+
export interface VectorSearchBedrockRerankingConfiguration {
|
|
726
|
+
modelConfiguration:
|
|
727
|
+
| VectorSearchBedrockRerankingModelConfiguration
|
|
728
|
+
| undefined;
|
|
729
|
+
numberOfRerankedResults?: number | undefined;
|
|
730
|
+
metadataConfiguration?: MetadataConfigurationForReranking | undefined;
|
|
731
|
+
}
|
|
732
|
+
export declare const VectorSearchRerankingConfigurationType: {
|
|
733
|
+
readonly BEDROCK_RERANKING_MODEL: "BEDROCK_RERANKING_MODEL";
|
|
734
|
+
};
|
|
735
|
+
export type VectorSearchRerankingConfigurationType =
|
|
736
|
+
(typeof VectorSearchRerankingConfigurationType)[keyof typeof VectorSearchRerankingConfigurationType];
|
|
737
|
+
export interface VectorSearchRerankingConfiguration {
|
|
738
|
+
type: VectorSearchRerankingConfigurationType | undefined;
|
|
739
|
+
bedrockRerankingConfiguration?:
|
|
740
|
+
| VectorSearchBedrockRerankingConfiguration
|
|
741
|
+
| undefined;
|
|
742
|
+
}
|
|
660
743
|
export declare const ConfirmationState: {
|
|
661
744
|
readonly CONFIRM: "CONFIRM";
|
|
662
745
|
readonly DENY: "DENY";
|
|
@@ -735,6 +818,9 @@ export interface RetrievalResultContent {
|
|
|
735
818
|
export interface RetrievalResultConfluenceLocation {
|
|
736
819
|
url?: string | undefined;
|
|
737
820
|
}
|
|
821
|
+
export interface RetrievalResultCustomDocumentLocation {
|
|
822
|
+
id?: string | undefined;
|
|
823
|
+
}
|
|
738
824
|
export interface RetrievalResultS3Location {
|
|
739
825
|
uri?: string | undefined;
|
|
740
826
|
}
|
|
@@ -746,6 +832,7 @@ export interface RetrievalResultSharePointLocation {
|
|
|
746
832
|
}
|
|
747
833
|
export declare const RetrievalResultLocationType: {
|
|
748
834
|
readonly CONFLUENCE: "CONFLUENCE";
|
|
835
|
+
readonly CUSTOM: "CUSTOM";
|
|
749
836
|
readonly S3: "S3";
|
|
750
837
|
readonly SALESFORCE: "SALESFORCE";
|
|
751
838
|
readonly SHAREPOINT: "SHAREPOINT";
|
|
@@ -763,6 +850,7 @@ export interface RetrievalResultLocation {
|
|
|
763
850
|
confluenceLocation?: RetrievalResultConfluenceLocation | undefined;
|
|
764
851
|
salesforceLocation?: RetrievalResultSalesforceLocation | undefined;
|
|
765
852
|
sharePointLocation?: RetrievalResultSharePointLocation | undefined;
|
|
853
|
+
customDocumentLocation?: RetrievalResultCustomDocumentLocation | undefined;
|
|
766
854
|
}
|
|
767
855
|
export interface RetrievedReference {
|
|
768
856
|
content?: RetrievalResultContent | undefined;
|
|
@@ -2137,6 +2225,70 @@ export declare namespace OptimizedPromptStream {
|
|
|
2137
2225
|
export interface OptimizePromptResponse {
|
|
2138
2226
|
optimizedPrompt: AsyncIterable<OptimizedPromptStream> | undefined;
|
|
2139
2227
|
}
|
|
2228
|
+
export interface RerankTextDocument {
|
|
2229
|
+
text?: string | undefined;
|
|
2230
|
+
}
|
|
2231
|
+
export declare const RerankQueryContentType: {
|
|
2232
|
+
readonly TEXT: "TEXT";
|
|
2233
|
+
};
|
|
2234
|
+
export type RerankQueryContentType =
|
|
2235
|
+
(typeof RerankQueryContentType)[keyof typeof RerankQueryContentType];
|
|
2236
|
+
export interface RerankQuery {
|
|
2237
|
+
type: RerankQueryContentType | undefined;
|
|
2238
|
+
textQuery: RerankTextDocument | undefined;
|
|
2239
|
+
}
|
|
2240
|
+
export interface BedrockRerankingModelConfiguration {
|
|
2241
|
+
modelArn: string | undefined;
|
|
2242
|
+
additionalModelRequestFields?: Record<string, __DocumentType> | undefined;
|
|
2243
|
+
}
|
|
2244
|
+
export interface BedrockRerankingConfiguration {
|
|
2245
|
+
numberOfResults?: number | undefined;
|
|
2246
|
+
modelConfiguration: BedrockRerankingModelConfiguration | undefined;
|
|
2247
|
+
}
|
|
2248
|
+
export declare const RerankingConfigurationType: {
|
|
2249
|
+
readonly BEDROCK_RERANKING_MODEL: "BEDROCK_RERANKING_MODEL";
|
|
2250
|
+
};
|
|
2251
|
+
export type RerankingConfigurationType =
|
|
2252
|
+
(typeof RerankingConfigurationType)[keyof typeof RerankingConfigurationType];
|
|
2253
|
+
export interface RerankingConfiguration {
|
|
2254
|
+
type: RerankingConfigurationType | undefined;
|
|
2255
|
+
bedrockRerankingConfiguration: BedrockRerankingConfiguration | undefined;
|
|
2256
|
+
}
|
|
2257
|
+
export declare const RerankDocumentType: {
|
|
2258
|
+
readonly JSON: "JSON";
|
|
2259
|
+
readonly TEXT: "TEXT";
|
|
2260
|
+
};
|
|
2261
|
+
export type RerankDocumentType =
|
|
2262
|
+
(typeof RerankDocumentType)[keyof typeof RerankDocumentType];
|
|
2263
|
+
export interface RerankDocument {
|
|
2264
|
+
type: RerankDocumentType | undefined;
|
|
2265
|
+
textDocument?: RerankTextDocument | undefined;
|
|
2266
|
+
jsonDocument?: __DocumentType | undefined;
|
|
2267
|
+
}
|
|
2268
|
+
export declare const RerankSourceType: {
|
|
2269
|
+
readonly INLINE: "INLINE";
|
|
2270
|
+
};
|
|
2271
|
+
export type RerankSourceType =
|
|
2272
|
+
(typeof RerankSourceType)[keyof typeof RerankSourceType];
|
|
2273
|
+
export interface RerankSource {
|
|
2274
|
+
type: RerankSourceType | undefined;
|
|
2275
|
+
inlineDocumentSource: RerankDocument | undefined;
|
|
2276
|
+
}
|
|
2277
|
+
export interface RerankRequest {
|
|
2278
|
+
queries: RerankQuery[] | undefined;
|
|
2279
|
+
sources: RerankSource[] | undefined;
|
|
2280
|
+
rerankingConfiguration: RerankingConfiguration | undefined;
|
|
2281
|
+
nextToken?: string | undefined;
|
|
2282
|
+
}
|
|
2283
|
+
export interface RerankResult {
|
|
2284
|
+
index: number | undefined;
|
|
2285
|
+
relevanceScore: number | undefined;
|
|
2286
|
+
document?: RerankDocument | undefined;
|
|
2287
|
+
}
|
|
2288
|
+
export interface RerankResponse {
|
|
2289
|
+
results: RerankResult[] | undefined;
|
|
2290
|
+
nextToken?: string | undefined;
|
|
2291
|
+
}
|
|
2140
2292
|
export interface RetrieveAndGenerateInput {
|
|
2141
2293
|
text: string | undefined;
|
|
2142
2294
|
}
|
|
@@ -2232,6 +2384,249 @@ export interface RetrieveAndGenerateResponse {
|
|
|
2232
2384
|
citations?: Citation[] | undefined;
|
|
2233
2385
|
guardrailAction?: GuadrailAction | undefined;
|
|
2234
2386
|
}
|
|
2387
|
+
export interface CitationEvent {
|
|
2388
|
+
citation?: Citation | undefined;
|
|
2389
|
+
}
|
|
2390
|
+
export interface GuardrailEvent {
|
|
2391
|
+
action?: GuadrailAction | undefined;
|
|
2392
|
+
}
|
|
2393
|
+
export interface RetrieveAndGenerateOutputEvent {
|
|
2394
|
+
text: string | undefined;
|
|
2395
|
+
}
|
|
2396
|
+
export type RetrieveAndGenerateStreamResponseOutput =
|
|
2397
|
+
| RetrieveAndGenerateStreamResponseOutput.AccessDeniedExceptionMember
|
|
2398
|
+
| RetrieveAndGenerateStreamResponseOutput.BadGatewayExceptionMember
|
|
2399
|
+
| RetrieveAndGenerateStreamResponseOutput.CitationMember
|
|
2400
|
+
| RetrieveAndGenerateStreamResponseOutput.ConflictExceptionMember
|
|
2401
|
+
| RetrieveAndGenerateStreamResponseOutput.DependencyFailedExceptionMember
|
|
2402
|
+
| RetrieveAndGenerateStreamResponseOutput.GuardrailMember
|
|
2403
|
+
| RetrieveAndGenerateStreamResponseOutput.InternalServerExceptionMember
|
|
2404
|
+
| RetrieveAndGenerateStreamResponseOutput.OutputMember
|
|
2405
|
+
| RetrieveAndGenerateStreamResponseOutput.ResourceNotFoundExceptionMember
|
|
2406
|
+
| RetrieveAndGenerateStreamResponseOutput.ServiceQuotaExceededExceptionMember
|
|
2407
|
+
| RetrieveAndGenerateStreamResponseOutput.ThrottlingExceptionMember
|
|
2408
|
+
| RetrieveAndGenerateStreamResponseOutput.ValidationExceptionMember
|
|
2409
|
+
| RetrieveAndGenerateStreamResponseOutput.$UnknownMember;
|
|
2410
|
+
export declare namespace RetrieveAndGenerateStreamResponseOutput {
|
|
2411
|
+
interface OutputMember {
|
|
2412
|
+
output: RetrieveAndGenerateOutputEvent;
|
|
2413
|
+
citation?: never;
|
|
2414
|
+
guardrail?: never;
|
|
2415
|
+
internalServerException?: never;
|
|
2416
|
+
validationException?: never;
|
|
2417
|
+
resourceNotFoundException?: never;
|
|
2418
|
+
serviceQuotaExceededException?: never;
|
|
2419
|
+
throttlingException?: never;
|
|
2420
|
+
accessDeniedException?: never;
|
|
2421
|
+
conflictException?: never;
|
|
2422
|
+
dependencyFailedException?: never;
|
|
2423
|
+
badGatewayException?: never;
|
|
2424
|
+
$unknown?: never;
|
|
2425
|
+
}
|
|
2426
|
+
interface CitationMember {
|
|
2427
|
+
output?: never;
|
|
2428
|
+
citation: CitationEvent;
|
|
2429
|
+
guardrail?: never;
|
|
2430
|
+
internalServerException?: never;
|
|
2431
|
+
validationException?: never;
|
|
2432
|
+
resourceNotFoundException?: never;
|
|
2433
|
+
serviceQuotaExceededException?: never;
|
|
2434
|
+
throttlingException?: never;
|
|
2435
|
+
accessDeniedException?: never;
|
|
2436
|
+
conflictException?: never;
|
|
2437
|
+
dependencyFailedException?: never;
|
|
2438
|
+
badGatewayException?: never;
|
|
2439
|
+
$unknown?: never;
|
|
2440
|
+
}
|
|
2441
|
+
interface GuardrailMember {
|
|
2442
|
+
output?: never;
|
|
2443
|
+
citation?: never;
|
|
2444
|
+
guardrail: GuardrailEvent;
|
|
2445
|
+
internalServerException?: never;
|
|
2446
|
+
validationException?: never;
|
|
2447
|
+
resourceNotFoundException?: never;
|
|
2448
|
+
serviceQuotaExceededException?: never;
|
|
2449
|
+
throttlingException?: never;
|
|
2450
|
+
accessDeniedException?: never;
|
|
2451
|
+
conflictException?: never;
|
|
2452
|
+
dependencyFailedException?: never;
|
|
2453
|
+
badGatewayException?: never;
|
|
2454
|
+
$unknown?: never;
|
|
2455
|
+
}
|
|
2456
|
+
interface InternalServerExceptionMember {
|
|
2457
|
+
output?: never;
|
|
2458
|
+
citation?: never;
|
|
2459
|
+
guardrail?: never;
|
|
2460
|
+
internalServerException: InternalServerException;
|
|
2461
|
+
validationException?: never;
|
|
2462
|
+
resourceNotFoundException?: never;
|
|
2463
|
+
serviceQuotaExceededException?: never;
|
|
2464
|
+
throttlingException?: never;
|
|
2465
|
+
accessDeniedException?: never;
|
|
2466
|
+
conflictException?: never;
|
|
2467
|
+
dependencyFailedException?: never;
|
|
2468
|
+
badGatewayException?: never;
|
|
2469
|
+
$unknown?: never;
|
|
2470
|
+
}
|
|
2471
|
+
interface ValidationExceptionMember {
|
|
2472
|
+
output?: never;
|
|
2473
|
+
citation?: never;
|
|
2474
|
+
guardrail?: never;
|
|
2475
|
+
internalServerException?: never;
|
|
2476
|
+
validationException: ValidationException;
|
|
2477
|
+
resourceNotFoundException?: never;
|
|
2478
|
+
serviceQuotaExceededException?: never;
|
|
2479
|
+
throttlingException?: never;
|
|
2480
|
+
accessDeniedException?: never;
|
|
2481
|
+
conflictException?: never;
|
|
2482
|
+
dependencyFailedException?: never;
|
|
2483
|
+
badGatewayException?: never;
|
|
2484
|
+
$unknown?: never;
|
|
2485
|
+
}
|
|
2486
|
+
interface ResourceNotFoundExceptionMember {
|
|
2487
|
+
output?: never;
|
|
2488
|
+
citation?: never;
|
|
2489
|
+
guardrail?: never;
|
|
2490
|
+
internalServerException?: never;
|
|
2491
|
+
validationException?: never;
|
|
2492
|
+
resourceNotFoundException: ResourceNotFoundException;
|
|
2493
|
+
serviceQuotaExceededException?: never;
|
|
2494
|
+
throttlingException?: never;
|
|
2495
|
+
accessDeniedException?: never;
|
|
2496
|
+
conflictException?: never;
|
|
2497
|
+
dependencyFailedException?: never;
|
|
2498
|
+
badGatewayException?: never;
|
|
2499
|
+
$unknown?: never;
|
|
2500
|
+
}
|
|
2501
|
+
interface ServiceQuotaExceededExceptionMember {
|
|
2502
|
+
output?: never;
|
|
2503
|
+
citation?: never;
|
|
2504
|
+
guardrail?: never;
|
|
2505
|
+
internalServerException?: never;
|
|
2506
|
+
validationException?: never;
|
|
2507
|
+
resourceNotFoundException?: never;
|
|
2508
|
+
serviceQuotaExceededException: ServiceQuotaExceededException;
|
|
2509
|
+
throttlingException?: never;
|
|
2510
|
+
accessDeniedException?: never;
|
|
2511
|
+
conflictException?: never;
|
|
2512
|
+
dependencyFailedException?: never;
|
|
2513
|
+
badGatewayException?: never;
|
|
2514
|
+
$unknown?: never;
|
|
2515
|
+
}
|
|
2516
|
+
interface ThrottlingExceptionMember {
|
|
2517
|
+
output?: never;
|
|
2518
|
+
citation?: never;
|
|
2519
|
+
guardrail?: never;
|
|
2520
|
+
internalServerException?: never;
|
|
2521
|
+
validationException?: never;
|
|
2522
|
+
resourceNotFoundException?: never;
|
|
2523
|
+
serviceQuotaExceededException?: never;
|
|
2524
|
+
throttlingException: ThrottlingException;
|
|
2525
|
+
accessDeniedException?: never;
|
|
2526
|
+
conflictException?: never;
|
|
2527
|
+
dependencyFailedException?: never;
|
|
2528
|
+
badGatewayException?: never;
|
|
2529
|
+
$unknown?: never;
|
|
2530
|
+
}
|
|
2531
|
+
interface AccessDeniedExceptionMember {
|
|
2532
|
+
output?: never;
|
|
2533
|
+
citation?: never;
|
|
2534
|
+
guardrail?: never;
|
|
2535
|
+
internalServerException?: never;
|
|
2536
|
+
validationException?: never;
|
|
2537
|
+
resourceNotFoundException?: never;
|
|
2538
|
+
serviceQuotaExceededException?: never;
|
|
2539
|
+
throttlingException?: never;
|
|
2540
|
+
accessDeniedException: AccessDeniedException;
|
|
2541
|
+
conflictException?: never;
|
|
2542
|
+
dependencyFailedException?: never;
|
|
2543
|
+
badGatewayException?: never;
|
|
2544
|
+
$unknown?: never;
|
|
2545
|
+
}
|
|
2546
|
+
interface ConflictExceptionMember {
|
|
2547
|
+
output?: never;
|
|
2548
|
+
citation?: never;
|
|
2549
|
+
guardrail?: never;
|
|
2550
|
+
internalServerException?: never;
|
|
2551
|
+
validationException?: never;
|
|
2552
|
+
resourceNotFoundException?: never;
|
|
2553
|
+
serviceQuotaExceededException?: never;
|
|
2554
|
+
throttlingException?: never;
|
|
2555
|
+
accessDeniedException?: never;
|
|
2556
|
+
conflictException: ConflictException;
|
|
2557
|
+
dependencyFailedException?: never;
|
|
2558
|
+
badGatewayException?: never;
|
|
2559
|
+
$unknown?: never;
|
|
2560
|
+
}
|
|
2561
|
+
interface DependencyFailedExceptionMember {
|
|
2562
|
+
output?: never;
|
|
2563
|
+
citation?: never;
|
|
2564
|
+
guardrail?: never;
|
|
2565
|
+
internalServerException?: never;
|
|
2566
|
+
validationException?: never;
|
|
2567
|
+
resourceNotFoundException?: never;
|
|
2568
|
+
serviceQuotaExceededException?: never;
|
|
2569
|
+
throttlingException?: never;
|
|
2570
|
+
accessDeniedException?: never;
|
|
2571
|
+
conflictException?: never;
|
|
2572
|
+
dependencyFailedException: DependencyFailedException;
|
|
2573
|
+
badGatewayException?: never;
|
|
2574
|
+
$unknown?: never;
|
|
2575
|
+
}
|
|
2576
|
+
interface BadGatewayExceptionMember {
|
|
2577
|
+
output?: never;
|
|
2578
|
+
citation?: never;
|
|
2579
|
+
guardrail?: never;
|
|
2580
|
+
internalServerException?: never;
|
|
2581
|
+
validationException?: never;
|
|
2582
|
+
resourceNotFoundException?: never;
|
|
2583
|
+
serviceQuotaExceededException?: never;
|
|
2584
|
+
throttlingException?: never;
|
|
2585
|
+
accessDeniedException?: never;
|
|
2586
|
+
conflictException?: never;
|
|
2587
|
+
dependencyFailedException?: never;
|
|
2588
|
+
badGatewayException: BadGatewayException;
|
|
2589
|
+
$unknown?: never;
|
|
2590
|
+
}
|
|
2591
|
+
interface $UnknownMember {
|
|
2592
|
+
output?: never;
|
|
2593
|
+
citation?: never;
|
|
2594
|
+
guardrail?: never;
|
|
2595
|
+
internalServerException?: never;
|
|
2596
|
+
validationException?: never;
|
|
2597
|
+
resourceNotFoundException?: never;
|
|
2598
|
+
serviceQuotaExceededException?: never;
|
|
2599
|
+
throttlingException?: never;
|
|
2600
|
+
accessDeniedException?: never;
|
|
2601
|
+
conflictException?: never;
|
|
2602
|
+
dependencyFailedException?: never;
|
|
2603
|
+
badGatewayException?: never;
|
|
2604
|
+
$unknown: [string, any];
|
|
2605
|
+
}
|
|
2606
|
+
interface Visitor<T> {
|
|
2607
|
+
output: (value: RetrieveAndGenerateOutputEvent) => T;
|
|
2608
|
+
citation: (value: CitationEvent) => T;
|
|
2609
|
+
guardrail: (value: GuardrailEvent) => T;
|
|
2610
|
+
internalServerException: (value: InternalServerException) => T;
|
|
2611
|
+
validationException: (value: ValidationException) => T;
|
|
2612
|
+
resourceNotFoundException: (value: ResourceNotFoundException) => T;
|
|
2613
|
+
serviceQuotaExceededException: (value: ServiceQuotaExceededException) => T;
|
|
2614
|
+
throttlingException: (value: ThrottlingException) => T;
|
|
2615
|
+
accessDeniedException: (value: AccessDeniedException) => T;
|
|
2616
|
+
conflictException: (value: ConflictException) => T;
|
|
2617
|
+
dependencyFailedException: (value: DependencyFailedException) => T;
|
|
2618
|
+
badGatewayException: (value: BadGatewayException) => T;
|
|
2619
|
+
_: (name: string, value: any) => T;
|
|
2620
|
+
}
|
|
2621
|
+
const visit: <T>(
|
|
2622
|
+
value: RetrieveAndGenerateStreamResponseOutput,
|
|
2623
|
+
visitor: Visitor<T>
|
|
2624
|
+
) => T;
|
|
2625
|
+
}
|
|
2626
|
+
export interface RetrieveAndGenerateStreamResponse {
|
|
2627
|
+
stream: AsyncIterable<RetrieveAndGenerateStreamResponseOutput> | undefined;
|
|
2628
|
+
sessionId: string | undefined;
|
|
2629
|
+
}
|
|
2235
2630
|
export interface KnowledgeBaseQuery {
|
|
2236
2631
|
text: string | undefined;
|
|
2237
2632
|
}
|
|
@@ -2243,6 +2638,7 @@ export interface KnowledgeBaseRetrievalResult {
|
|
|
2243
2638
|
}
|
|
2244
2639
|
export interface RetrieveResponse {
|
|
2245
2640
|
retrievalResults: KnowledgeBaseRetrievalResult[] | undefined;
|
|
2641
|
+
guardrailAction?: GuadrailAction | undefined;
|
|
2246
2642
|
nextToken?: string | undefined;
|
|
2247
2643
|
}
|
|
2248
2644
|
export type RetrievalFilter =
|
|
@@ -2507,6 +2903,8 @@ export interface KnowledgeBaseVectorSearchConfiguration {
|
|
|
2507
2903
|
numberOfResults?: number | undefined;
|
|
2508
2904
|
overrideSearchType?: SearchType | undefined;
|
|
2509
2905
|
filter?: RetrievalFilter | undefined;
|
|
2906
|
+
rerankingConfiguration?: VectorSearchRerankingConfiguration | undefined;
|
|
2907
|
+
implicitFilterConfiguration?: ImplicitFilterConfiguration | undefined;
|
|
2510
2908
|
}
|
|
2511
2909
|
export interface KnowledgeBaseRetrievalConfiguration {
|
|
2512
2910
|
vectorSearchConfiguration: KnowledgeBaseVectorSearchConfiguration | undefined;
|
|
@@ -2531,6 +2929,7 @@ export interface RetrieveRequest {
|
|
|
2531
2929
|
knowledgeBaseId: string | undefined;
|
|
2532
2930
|
retrievalQuery: KnowledgeBaseQuery | undefined;
|
|
2533
2931
|
retrievalConfiguration?: KnowledgeBaseRetrievalConfiguration | undefined;
|
|
2932
|
+
guardrailConfiguration?: GuardrailConfiguration | undefined;
|
|
2534
2933
|
nextToken?: string | undefined;
|
|
2535
2934
|
}
|
|
2536
2935
|
export interface RetrieveAndGenerateConfiguration {
|
|
@@ -2565,6 +2964,14 @@ export interface RetrieveAndGenerateRequest {
|
|
|
2565
2964
|
| undefined;
|
|
2566
2965
|
sessionConfiguration?: RetrieveAndGenerateSessionConfiguration | undefined;
|
|
2567
2966
|
}
|
|
2967
|
+
export interface RetrieveAndGenerateStreamRequest {
|
|
2968
|
+
sessionId?: string | undefined;
|
|
2969
|
+
input: RetrieveAndGenerateInput | undefined;
|
|
2970
|
+
retrieveAndGenerateConfiguration?:
|
|
2971
|
+
| RetrieveAndGenerateConfiguration
|
|
2972
|
+
| undefined;
|
|
2973
|
+
sessionConfiguration?: RetrieveAndGenerateSessionConfiguration | undefined;
|
|
2974
|
+
}
|
|
2568
2975
|
export interface SessionState {
|
|
2569
2976
|
sessionAttributes?: Record<string, string> | undefined;
|
|
2570
2977
|
promptSessionAttributes?: Record<string, string> | undefined;
|
|
@@ -2649,6 +3056,24 @@ export declare const ByteContentFileFilterSensitiveLog: (
|
|
|
2649
3056
|
) => any;
|
|
2650
3057
|
export declare const FileSourceFilterSensitiveLog: (obj: FileSource) => any;
|
|
2651
3058
|
export declare const InputFileFilterSensitiveLog: (obj: InputFile) => any;
|
|
3059
|
+
export declare const MetadataAttributeSchemaFilterSensitiveLog: (
|
|
3060
|
+
obj: MetadataAttributeSchema
|
|
3061
|
+
) => any;
|
|
3062
|
+
export declare const ImplicitFilterConfigurationFilterSensitiveLog: (
|
|
3063
|
+
obj: ImplicitFilterConfiguration
|
|
3064
|
+
) => any;
|
|
3065
|
+
export declare const RerankingMetadataSelectiveModeConfigurationFilterSensitiveLog: (
|
|
3066
|
+
obj: RerankingMetadataSelectiveModeConfiguration
|
|
3067
|
+
) => any;
|
|
3068
|
+
export declare const MetadataConfigurationForRerankingFilterSensitiveLog: (
|
|
3069
|
+
obj: MetadataConfigurationForReranking
|
|
3070
|
+
) => any;
|
|
3071
|
+
export declare const VectorSearchBedrockRerankingConfigurationFilterSensitiveLog: (
|
|
3072
|
+
obj: VectorSearchBedrockRerankingConfiguration
|
|
3073
|
+
) => any;
|
|
3074
|
+
export declare const VectorSearchRerankingConfigurationFilterSensitiveLog: (
|
|
3075
|
+
obj: VectorSearchRerankingConfiguration
|
|
3076
|
+
) => any;
|
|
2652
3077
|
export declare const ApiResultFilterSensitiveLog: (obj: ApiResult) => any;
|
|
2653
3078
|
export declare const InvocationResultMemberFilterSensitiveLog: (
|
|
2654
3079
|
obj: InvocationResultMember
|
|
@@ -2827,6 +3252,21 @@ export declare const OptimizedPromptStreamFilterSensitiveLog: (
|
|
|
2827
3252
|
export declare const OptimizePromptResponseFilterSensitiveLog: (
|
|
2828
3253
|
obj: OptimizePromptResponse
|
|
2829
3254
|
) => any;
|
|
3255
|
+
export declare const RerankTextDocumentFilterSensitiveLog: (
|
|
3256
|
+
obj: RerankTextDocument
|
|
3257
|
+
) => any;
|
|
3258
|
+
export declare const RerankQueryFilterSensitiveLog: (obj: RerankQuery) => any;
|
|
3259
|
+
export declare const RerankDocumentFilterSensitiveLog: (
|
|
3260
|
+
obj: RerankDocument
|
|
3261
|
+
) => any;
|
|
3262
|
+
export declare const RerankSourceFilterSensitiveLog: (obj: RerankSource) => any;
|
|
3263
|
+
export declare const RerankRequestFilterSensitiveLog: (
|
|
3264
|
+
obj: RerankRequest
|
|
3265
|
+
) => any;
|
|
3266
|
+
export declare const RerankResultFilterSensitiveLog: (obj: RerankResult) => any;
|
|
3267
|
+
export declare const RerankResponseFilterSensitiveLog: (
|
|
3268
|
+
obj: RerankResponse
|
|
3269
|
+
) => any;
|
|
2830
3270
|
export declare const RetrieveAndGenerateInputFilterSensitiveLog: (
|
|
2831
3271
|
obj: RetrieveAndGenerateInput
|
|
2832
3272
|
) => any;
|
|
@@ -2857,6 +3297,18 @@ export declare const RetrieveAndGenerateOutputFilterSensitiveLog: (
|
|
|
2857
3297
|
export declare const RetrieveAndGenerateResponseFilterSensitiveLog: (
|
|
2858
3298
|
obj: RetrieveAndGenerateResponse
|
|
2859
3299
|
) => any;
|
|
3300
|
+
export declare const CitationEventFilterSensitiveLog: (
|
|
3301
|
+
obj: CitationEvent
|
|
3302
|
+
) => any;
|
|
3303
|
+
export declare const RetrieveAndGenerateOutputEventFilterSensitiveLog: (
|
|
3304
|
+
obj: RetrieveAndGenerateOutputEvent
|
|
3305
|
+
) => any;
|
|
3306
|
+
export declare const RetrieveAndGenerateStreamResponseOutputFilterSensitiveLog: (
|
|
3307
|
+
obj: RetrieveAndGenerateStreamResponseOutput
|
|
3308
|
+
) => any;
|
|
3309
|
+
export declare const RetrieveAndGenerateStreamResponseFilterSensitiveLog: (
|
|
3310
|
+
obj: RetrieveAndGenerateStreamResponse
|
|
3311
|
+
) => any;
|
|
2860
3312
|
export declare const KnowledgeBaseQueryFilterSensitiveLog: (
|
|
2861
3313
|
obj: KnowledgeBaseQuery
|
|
2862
3314
|
) => any;
|
|
@@ -2896,6 +3348,9 @@ export declare const InvokeInlineAgentRequestFilterSensitiveLog: (
|
|
|
2896
3348
|
export declare const RetrieveAndGenerateRequestFilterSensitiveLog: (
|
|
2897
3349
|
obj: RetrieveAndGenerateRequest
|
|
2898
3350
|
) => any;
|
|
3351
|
+
export declare const RetrieveAndGenerateStreamRequestFilterSensitiveLog: (
|
|
3352
|
+
obj: RetrieveAndGenerateStreamRequest
|
|
3353
|
+
) => any;
|
|
2899
3354
|
export declare const SessionStateFilterSensitiveLog: (obj: SessionState) => any;
|
|
2900
3355
|
export declare const InvokeAgentRequestFilterSensitiveLog: (
|
|
2901
3356
|
obj: InvokeAgentRequest
|
|
@@ -0,0 +1,11 @@
|
|
|
1
|
+
import { Paginator } from "@smithy/types";
|
|
2
|
+
import {
|
|
3
|
+
RerankCommandInput,
|
|
4
|
+
RerankCommandOutput,
|
|
5
|
+
} from "../commands/RerankCommand";
|
|
6
|
+
import { BedrockAgentRuntimePaginationConfiguration } from "./Interfaces";
|
|
7
|
+
export declare const paginateRerank: (
|
|
8
|
+
config: BedrockAgentRuntimePaginationConfiguration,
|
|
9
|
+
input: RerankCommandInput,
|
|
10
|
+
...rest: any[]
|
|
11
|
+
) => Paginator<RerankCommandOutput>;
|
|
@@ -30,10 +30,18 @@ import {
|
|
|
30
30
|
OptimizePromptCommandInput,
|
|
31
31
|
OptimizePromptCommandOutput,
|
|
32
32
|
} from "../commands/OptimizePromptCommand";
|
|
33
|
+
import {
|
|
34
|
+
RerankCommandInput,
|
|
35
|
+
RerankCommandOutput,
|
|
36
|
+
} from "../commands/RerankCommand";
|
|
33
37
|
import {
|
|
34
38
|
RetrieveAndGenerateCommandInput,
|
|
35
39
|
RetrieveAndGenerateCommandOutput,
|
|
36
40
|
} from "../commands/RetrieveAndGenerateCommand";
|
|
41
|
+
import {
|
|
42
|
+
RetrieveAndGenerateStreamCommandInput,
|
|
43
|
+
RetrieveAndGenerateStreamCommandOutput,
|
|
44
|
+
} from "../commands/RetrieveAndGenerateStreamCommand";
|
|
37
45
|
import {
|
|
38
46
|
RetrieveCommandInput,
|
|
39
47
|
RetrieveCommandOutput,
|
|
@@ -62,6 +70,10 @@ export declare const se_OptimizePromptCommand: (
|
|
|
62
70
|
input: OptimizePromptCommandInput,
|
|
63
71
|
context: __SerdeContext
|
|
64
72
|
) => Promise<__HttpRequest>;
|
|
73
|
+
export declare const se_RerankCommand: (
|
|
74
|
+
input: RerankCommandInput,
|
|
75
|
+
context: __SerdeContext
|
|
76
|
+
) => Promise<__HttpRequest>;
|
|
65
77
|
export declare const se_RetrieveCommand: (
|
|
66
78
|
input: RetrieveCommandInput,
|
|
67
79
|
context: __SerdeContext
|
|
@@ -70,6 +82,10 @@ export declare const se_RetrieveAndGenerateCommand: (
|
|
|
70
82
|
input: RetrieveAndGenerateCommandInput,
|
|
71
83
|
context: __SerdeContext
|
|
72
84
|
) => Promise<__HttpRequest>;
|
|
85
|
+
export declare const se_RetrieveAndGenerateStreamCommand: (
|
|
86
|
+
input: RetrieveAndGenerateStreamCommandInput,
|
|
87
|
+
context: __SerdeContext
|
|
88
|
+
) => Promise<__HttpRequest>;
|
|
73
89
|
export declare const de_DeleteAgentMemoryCommand: (
|
|
74
90
|
output: __HttpResponse,
|
|
75
91
|
context: __SerdeContext
|
|
@@ -94,6 +110,10 @@ export declare const de_OptimizePromptCommand: (
|
|
|
94
110
|
output: __HttpResponse,
|
|
95
111
|
context: __SerdeContext & __EventStreamSerdeContext
|
|
96
112
|
) => Promise<OptimizePromptCommandOutput>;
|
|
113
|
+
export declare const de_RerankCommand: (
|
|
114
|
+
output: __HttpResponse,
|
|
115
|
+
context: __SerdeContext
|
|
116
|
+
) => Promise<RerankCommandOutput>;
|
|
97
117
|
export declare const de_RetrieveCommand: (
|
|
98
118
|
output: __HttpResponse,
|
|
99
119
|
context: __SerdeContext
|
|
@@ -102,3 +122,7 @@ export declare const de_RetrieveAndGenerateCommand: (
|
|
|
102
122
|
output: __HttpResponse,
|
|
103
123
|
context: __SerdeContext
|
|
104
124
|
) => Promise<RetrieveAndGenerateCommandOutput>;
|
|
125
|
+
export declare const de_RetrieveAndGenerateStreamCommand: (
|
|
126
|
+
output: __HttpResponse,
|
|
127
|
+
context: __SerdeContext & __EventStreamSerdeContext
|
|
128
|
+
) => Promise<RetrieveAndGenerateStreamCommandOutput>;
|
package/package.json
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@aws-sdk/client-bedrock-agent-runtime",
|
|
3
3
|
"description": "AWS SDK for JavaScript Bedrock Agent Runtime Client for Node.js, Browser and React Native",
|
|
4
|
-
"version": "3.
|
|
4
|
+
"version": "3.703.0",
|
|
5
5
|
"scripts": {
|
|
6
6
|
"build": "concurrently 'yarn:build:cjs' 'yarn:build:es' 'yarn:build:types'",
|
|
7
7
|
"build:cjs": "node ../../scripts/compilation/inline client-bedrock-agent-runtime",
|