@aws-sdk/client-bedrock 3.830.0 → 3.834.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/dist-cjs/index.js +84 -44
- package/dist-es/models/models_0.js +28 -54
- package/dist-es/models/models_1.js +55 -1
- package/dist-es/protocols/Aws_restJson1.js +2 -2
- package/dist-types/commands/CreateCustomModelCommand.d.ts +1 -1
- package/dist-types/commands/CreateGuardrailCommand.d.ts +6 -0
- package/dist-types/commands/GetGuardrailCommand.d.ts +6 -0
- package/dist-types/commands/UpdateGuardrailCommand.d.ts +6 -0
- package/dist-types/models/models_0.d.ts +106 -168
- package/dist-types/models/models_1.d.ts +167 -1
- package/dist-types/ts3.4/models/models_0.d.ts +40 -75
- package/dist-types/ts3.4/models/models_1.d.ts +81 -1
- package/package.json +1 -1
|
@@ -475,7 +475,7 @@ export interface UpdateMarketplaceModelEndpointResponse {
|
|
|
475
475
|
marketplaceModelEndpoint: MarketplaceModelEndpoint | undefined;
|
|
476
476
|
}
|
|
477
477
|
/**
|
|
478
|
-
* <p>The Amazon S3 data source of the model to import.
|
|
478
|
+
* <p>The Amazon S3 data source of the model to import. </p>
|
|
479
479
|
* @public
|
|
480
480
|
*/
|
|
481
481
|
export interface S3DataSource {
|
|
@@ -525,7 +525,7 @@ export interface CreateCustomModelRequest {
|
|
|
525
525
|
*/
|
|
526
526
|
modelName: string | undefined;
|
|
527
527
|
/**
|
|
528
|
-
* <p>The data source for the model. The Amazon S3 URI in the model source must be for the Amazon-managed Amazon S3 bucket containing your model artifacts
|
|
528
|
+
* <p>The data source for the model. The Amazon S3 URI in the model source must be for the Amazon-managed Amazon S3 bucket containing your model artifacts.</p>
|
|
529
529
|
* @public
|
|
530
530
|
*/
|
|
531
531
|
modelSourceConfig: ModelDataSource | undefined;
|
|
@@ -2404,6 +2404,29 @@ export interface GuardrailContentFilterConfig {
|
|
|
2404
2404
|
*/
|
|
2405
2405
|
outputEnabled?: boolean | undefined;
|
|
2406
2406
|
}
|
|
2407
|
+
/**
|
|
2408
|
+
* @public
|
|
2409
|
+
* @enum
|
|
2410
|
+
*/
|
|
2411
|
+
export declare const GuardrailContentFiltersTierName: {
|
|
2412
|
+
readonly CLASSIC: "CLASSIC";
|
|
2413
|
+
readonly STANDARD: "STANDARD";
|
|
2414
|
+
};
|
|
2415
|
+
/**
|
|
2416
|
+
* @public
|
|
2417
|
+
*/
|
|
2418
|
+
export type GuardrailContentFiltersTierName = (typeof GuardrailContentFiltersTierName)[keyof typeof GuardrailContentFiltersTierName];
|
|
2419
|
+
/**
|
|
2420
|
+
* <p>The tier that your guardrail uses for content filters. Consider using a tier that balances performance, accuracy, and compatibility with your existing generative AI workflows.</p>
|
|
2421
|
+
* @public
|
|
2422
|
+
*/
|
|
2423
|
+
export interface GuardrailContentFiltersTierConfig {
|
|
2424
|
+
/**
|
|
2425
|
+
* <p>The tier that your guardrail uses for content filters. Valid values include:</p> <ul> <li> <p> <code>CLASSIC</code> tier – Provides established guardrails functionality supporting English, French, and Spanish languages.</p> </li> <li> <p> <code>STANDARD</code> tier – Provides a more robust solution than the <code>CLASSIC</code> tier and has more comprehensive language support. This tier requires that your guardrail use <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/guardrails-cross-region.html">cross-Region inference</a>.</p> </li> </ul>
|
|
2426
|
+
* @public
|
|
2427
|
+
*/
|
|
2428
|
+
tierName: GuardrailContentFiltersTierName | undefined;
|
|
2429
|
+
}
|
|
2407
2430
|
/**
|
|
2408
2431
|
* <p>Contains details about how to handle harmful content.</p>
|
|
2409
2432
|
* @public
|
|
@@ -2414,6 +2437,11 @@ export interface GuardrailContentPolicyConfig {
|
|
|
2414
2437
|
* @public
|
|
2415
2438
|
*/
|
|
2416
2439
|
filtersConfig: GuardrailContentFilterConfig[] | undefined;
|
|
2440
|
+
/**
|
|
2441
|
+
* <p>The tier that your guardrail uses for content filters.</p>
|
|
2442
|
+
* @public
|
|
2443
|
+
*/
|
|
2444
|
+
tierConfig?: GuardrailContentFiltersTierConfig | undefined;
|
|
2417
2445
|
}
|
|
2418
2446
|
/**
|
|
2419
2447
|
* @public
|
|
@@ -2639,6 +2667,29 @@ export interface GuardrailSensitiveInformationPolicyConfig {
|
|
|
2639
2667
|
*/
|
|
2640
2668
|
regexesConfig?: GuardrailRegexConfig[] | undefined;
|
|
2641
2669
|
}
|
|
2670
|
+
/**
|
|
2671
|
+
* @public
|
|
2672
|
+
* @enum
|
|
2673
|
+
*/
|
|
2674
|
+
export declare const GuardrailTopicsTierName: {
|
|
2675
|
+
readonly CLASSIC: "CLASSIC";
|
|
2676
|
+
readonly STANDARD: "STANDARD";
|
|
2677
|
+
};
|
|
2678
|
+
/**
|
|
2679
|
+
* @public
|
|
2680
|
+
*/
|
|
2681
|
+
export type GuardrailTopicsTierName = (typeof GuardrailTopicsTierName)[keyof typeof GuardrailTopicsTierName];
|
|
2682
|
+
/**
|
|
2683
|
+
* <p>The tier that your guardrail uses for denied topic filters. Consider using a tier that balances performance, accuracy, and compatibility with your existing generative AI workflows.</p>
|
|
2684
|
+
* @public
|
|
2685
|
+
*/
|
|
2686
|
+
export interface GuardrailTopicsTierConfig {
|
|
2687
|
+
/**
|
|
2688
|
+
* <p>The tier that your guardrail uses for denied topic filters. Valid values include:</p> <ul> <li> <p> <code>CLASSIC</code> tier – Provides established guardrails functionality supporting English, French, and Spanish languages.</p> </li> <li> <p> <code>STANDARD</code> tier – Provides a more robust solution than the <code>CLASSIC</code> tier and has more comprehensive language support. This tier requires that your guardrail use <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/guardrails-cross-region.html">cross-Region inference</a>.</p> </li> </ul>
|
|
2689
|
+
* @public
|
|
2690
|
+
*/
|
|
2691
|
+
tierName: GuardrailTopicsTierName | undefined;
|
|
2692
|
+
}
|
|
2642
2693
|
/**
|
|
2643
2694
|
* @public
|
|
2644
2695
|
* @enum
|
|
@@ -2718,6 +2769,11 @@ export interface GuardrailTopicPolicyConfig {
|
|
|
2718
2769
|
* @public
|
|
2719
2770
|
*/
|
|
2720
2771
|
topicsConfig: GuardrailTopicConfig[] | undefined;
|
|
2772
|
+
/**
|
|
2773
|
+
* <p>The tier that your guardrail uses for denied topic filters.</p>
|
|
2774
|
+
* @public
|
|
2775
|
+
*/
|
|
2776
|
+
tierConfig?: GuardrailTopicsTierConfig | undefined;
|
|
2721
2777
|
}
|
|
2722
2778
|
/**
|
|
2723
2779
|
* @public
|
|
@@ -3036,6 +3092,17 @@ export interface GuardrailContentFilter {
|
|
|
3036
3092
|
*/
|
|
3037
3093
|
outputEnabled?: boolean | undefined;
|
|
3038
3094
|
}
|
|
3095
|
+
/**
|
|
3096
|
+
* <p>The tier that your guardrail uses for content filters.</p>
|
|
3097
|
+
* @public
|
|
3098
|
+
*/
|
|
3099
|
+
export interface GuardrailContentFiltersTier {
|
|
3100
|
+
/**
|
|
3101
|
+
* <p>The tier that your guardrail uses for content filters. Valid values include:</p> <ul> <li> <p> <code>CLASSIC</code> tier – Provides established guardrails functionality supporting English, French, and Spanish languages.</p> </li> <li> <p> <code>STANDARD</code> tier – Provides a more robust solution than the <code>CLASSIC</code> tier and has more comprehensive language support. This tier requires that your guardrail use <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/guardrails-cross-region.html">cross-Region inference</a>.</p> </li> </ul>
|
|
3102
|
+
* @public
|
|
3103
|
+
*/
|
|
3104
|
+
tierName: GuardrailContentFiltersTierName | undefined;
|
|
3105
|
+
}
|
|
3039
3106
|
/**
|
|
3040
3107
|
* <p>Contains details about how to handle harmful content.</p> <p>This data type is used in the following API operations:</p> <ul> <li> <p> <a href="https://docs.aws.amazon.com/bedrock/latest/APIReference/API_GetGuardrail.html#API_GetGuardrail_ResponseSyntax">GetGuardrail response body</a> </p> </li> </ul>
|
|
3041
3108
|
* @public
|
|
@@ -3046,6 +3113,11 @@ export interface GuardrailContentPolicy {
|
|
|
3046
3113
|
* @public
|
|
3047
3114
|
*/
|
|
3048
3115
|
filters?: GuardrailContentFilter[] | undefined;
|
|
3116
|
+
/**
|
|
3117
|
+
* <p>The tier that your guardrail uses for content filters.</p>
|
|
3118
|
+
* @public
|
|
3119
|
+
*/
|
|
3120
|
+
tier?: GuardrailContentFiltersTier | undefined;
|
|
3049
3121
|
}
|
|
3050
3122
|
/**
|
|
3051
3123
|
* <p>The details for the guardrails contextual grounding filter.</p>
|
|
@@ -3214,6 +3286,17 @@ export declare const GuardrailStatus: {
|
|
|
3214
3286
|
* @public
|
|
3215
3287
|
*/
|
|
3216
3288
|
export type GuardrailStatus = (typeof GuardrailStatus)[keyof typeof GuardrailStatus];
|
|
3289
|
+
/**
|
|
3290
|
+
* <p>The tier that your guardrail uses for denied topic filters.</p>
|
|
3291
|
+
* @public
|
|
3292
|
+
*/
|
|
3293
|
+
export interface GuardrailTopicsTier {
|
|
3294
|
+
/**
|
|
3295
|
+
* <p>The tier that your guardrail uses for denied topic filters. Valid values include:</p> <ul> <li> <p> <code>CLASSIC</code> tier – Provides established guardrails functionality supporting English, French, and Spanish languages.</p> </li> <li> <p> <code>STANDARD</code> tier – Provides a more robust solution than the <code>CLASSIC</code> tier and has more comprehensive language support. This tier requires that your guardrail use <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/guardrails-cross-region.html">cross-Region inference</a>.</p> </li> </ul>
|
|
3296
|
+
* @public
|
|
3297
|
+
*/
|
|
3298
|
+
tierName: GuardrailTopicsTierName | undefined;
|
|
3299
|
+
}
|
|
3217
3300
|
/**
|
|
3218
3301
|
* <p>Details about topics for the guardrail to identify and deny.</p> <p>This data type is used in the following API operations:</p> <ul> <li> <p> <a href="https://docs.aws.amazon.com/bedrock/latest/APIReference/API_GetGuardrail.html#API_GetGuardrail_ResponseSyntax">GetGuardrail response body</a> </p> </li> </ul>
|
|
3219
3302
|
* @public
|
|
@@ -3270,6 +3353,11 @@ export interface GuardrailTopicPolicy {
|
|
|
3270
3353
|
* @public
|
|
3271
3354
|
*/
|
|
3272
3355
|
topics: GuardrailTopic[] | undefined;
|
|
3356
|
+
/**
|
|
3357
|
+
* <p>The tier that your guardrail uses for denied topic filters.</p>
|
|
3358
|
+
* @public
|
|
3359
|
+
*/
|
|
3360
|
+
tier?: GuardrailTopicsTier | undefined;
|
|
3273
3361
|
}
|
|
3274
3362
|
/**
|
|
3275
3363
|
* <p>The managed word list that was configured for the guardrail. (This is a list of words that are pre-defined and managed by guardrails only.)</p>
|
|
@@ -6821,148 +6909,6 @@ export declare namespace RetrievalFilter {
|
|
|
6821
6909
|
}
|
|
6822
6910
|
const visit: <T>(value: RetrievalFilter, visitor: Visitor<T>) => T;
|
|
6823
6911
|
}
|
|
6824
|
-
/**
|
|
6825
|
-
* <p>The configuration details for returning the results from the knowledge base vector search.</p>
|
|
6826
|
-
* @public
|
|
6827
|
-
*/
|
|
6828
|
-
export interface KnowledgeBaseVectorSearchConfiguration {
|
|
6829
|
-
/**
|
|
6830
|
-
* <p>The number of text chunks to retrieve; the number of results to return.</p>
|
|
6831
|
-
* @public
|
|
6832
|
-
*/
|
|
6833
|
-
numberOfResults?: number | undefined;
|
|
6834
|
-
/**
|
|
6835
|
-
* <p>By default, Amazon Bedrock decides a search strategy for you. If you're using an Amazon OpenSearch Serverless vector store that contains a filterable text field, you can specify whether to query the knowledge base with a <code>HYBRID</code> search using both vector embeddings and raw text, or <code>SEMANTIC</code> search using only vector embeddings. For other vector store configurations, only <code>SEMANTIC</code> search is available.</p>
|
|
6836
|
-
* @public
|
|
6837
|
-
*/
|
|
6838
|
-
overrideSearchType?: SearchType | undefined;
|
|
6839
|
-
/**
|
|
6840
|
-
* <p>Specifies the filters to use on the metadata fields in the knowledge base data sources before returning results.</p>
|
|
6841
|
-
* @public
|
|
6842
|
-
*/
|
|
6843
|
-
filter?: RetrievalFilter | undefined;
|
|
6844
|
-
}
|
|
6845
|
-
/**
|
|
6846
|
-
* <p>Contains configuration details for retrieving information from a knowledge base.</p>
|
|
6847
|
-
* @public
|
|
6848
|
-
*/
|
|
6849
|
-
export interface KnowledgeBaseRetrievalConfiguration {
|
|
6850
|
-
/**
|
|
6851
|
-
* <p>Contains configuration details for returning the results from the vector search.</p>
|
|
6852
|
-
* @public
|
|
6853
|
-
*/
|
|
6854
|
-
vectorSearchConfiguration: KnowledgeBaseVectorSearchConfiguration | undefined;
|
|
6855
|
-
}
|
|
6856
|
-
/**
|
|
6857
|
-
* <p>Contains configuration details for retrieving information from a knowledge base and generating responses.</p>
|
|
6858
|
-
* @public
|
|
6859
|
-
*/
|
|
6860
|
-
export interface KnowledgeBaseRetrieveAndGenerateConfiguration {
|
|
6861
|
-
/**
|
|
6862
|
-
* <p>The unique identifier of the knowledge base.</p>
|
|
6863
|
-
* @public
|
|
6864
|
-
*/
|
|
6865
|
-
knowledgeBaseId: string | undefined;
|
|
6866
|
-
/**
|
|
6867
|
-
* <p>The Amazon Resource Name (ARN) of the foundation model or <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/cross-region-inference.html">inference profile</a> used to generate responses.</p>
|
|
6868
|
-
* @public
|
|
6869
|
-
*/
|
|
6870
|
-
modelArn: string | undefined;
|
|
6871
|
-
/**
|
|
6872
|
-
* <p>Contains configuration details for retrieving text chunks.</p>
|
|
6873
|
-
* @public
|
|
6874
|
-
*/
|
|
6875
|
-
retrievalConfiguration?: KnowledgeBaseRetrievalConfiguration | undefined;
|
|
6876
|
-
/**
|
|
6877
|
-
* <p>Contains configurations details for response generation based on retrieved text chunks.</p>
|
|
6878
|
-
* @public
|
|
6879
|
-
*/
|
|
6880
|
-
generationConfiguration?: GenerationConfiguration | undefined;
|
|
6881
|
-
/**
|
|
6882
|
-
* <p>Contains configuration details for the model to process the prompt prior to retrieval and response generation.</p>
|
|
6883
|
-
* @public
|
|
6884
|
-
*/
|
|
6885
|
-
orchestrationConfiguration?: OrchestrationConfiguration | undefined;
|
|
6886
|
-
}
|
|
6887
|
-
/**
|
|
6888
|
-
* <p>The configuration details for retrieving information from a knowledge base.</p>
|
|
6889
|
-
* @public
|
|
6890
|
-
*/
|
|
6891
|
-
export interface RetrieveConfig {
|
|
6892
|
-
/**
|
|
6893
|
-
* <p>The unique identifier of the knowledge base.</p>
|
|
6894
|
-
* @public
|
|
6895
|
-
*/
|
|
6896
|
-
knowledgeBaseId: string | undefined;
|
|
6897
|
-
/**
|
|
6898
|
-
* <p>Contains configuration details for knowledge base retrieval.</p>
|
|
6899
|
-
* @public
|
|
6900
|
-
*/
|
|
6901
|
-
knowledgeBaseRetrievalConfiguration: KnowledgeBaseRetrievalConfiguration | undefined;
|
|
6902
|
-
}
|
|
6903
|
-
/**
|
|
6904
|
-
* <p>Contains configuration details for a knowledge base retrieval and response generation.</p>
|
|
6905
|
-
* @public
|
|
6906
|
-
*/
|
|
6907
|
-
export interface RetrieveAndGenerateConfiguration {
|
|
6908
|
-
/**
|
|
6909
|
-
* <p>The type of resource that contains your data for retrieving information and generating responses.</p> <p>If you choose to use <code>EXTERNAL_SOURCES</code>, then currently only Claude 3 Sonnet models for knowledge bases are supported.</p>
|
|
6910
|
-
* @public
|
|
6911
|
-
*/
|
|
6912
|
-
type: RetrieveAndGenerateType | undefined;
|
|
6913
|
-
/**
|
|
6914
|
-
* <p>Contains configuration details for the knowledge base retrieval and response generation.</p>
|
|
6915
|
-
* @public
|
|
6916
|
-
*/
|
|
6917
|
-
knowledgeBaseConfiguration?: KnowledgeBaseRetrieveAndGenerateConfiguration | undefined;
|
|
6918
|
-
/**
|
|
6919
|
-
* <p>The configuration for the external source wrapper object in the <code>retrieveAndGenerate</code> function.</p>
|
|
6920
|
-
* @public
|
|
6921
|
-
*/
|
|
6922
|
-
externalSourcesConfiguration?: ExternalSourcesRetrieveAndGenerateConfiguration | undefined;
|
|
6923
|
-
}
|
|
6924
|
-
/**
|
|
6925
|
-
* <p>The configuration details for retrieving information from a knowledge base and generating responses.</p>
|
|
6926
|
-
* @public
|
|
6927
|
-
*/
|
|
6928
|
-
export type KnowledgeBaseConfig = KnowledgeBaseConfig.RetrieveAndGenerateConfigMember | KnowledgeBaseConfig.RetrieveConfigMember | KnowledgeBaseConfig.$UnknownMember;
|
|
6929
|
-
/**
|
|
6930
|
-
* @public
|
|
6931
|
-
*/
|
|
6932
|
-
export declare namespace KnowledgeBaseConfig {
|
|
6933
|
-
/**
|
|
6934
|
-
* <p>Contains configuration details for retrieving information from a knowledge base.</p>
|
|
6935
|
-
* @public
|
|
6936
|
-
*/
|
|
6937
|
-
interface RetrieveConfigMember {
|
|
6938
|
-
retrieveConfig: RetrieveConfig;
|
|
6939
|
-
retrieveAndGenerateConfig?: never;
|
|
6940
|
-
$unknown?: never;
|
|
6941
|
-
}
|
|
6942
|
-
/**
|
|
6943
|
-
* <p>Contains configuration details for retrieving information from a knowledge base and generating responses.</p>
|
|
6944
|
-
* @public
|
|
6945
|
-
*/
|
|
6946
|
-
interface RetrieveAndGenerateConfigMember {
|
|
6947
|
-
retrieveConfig?: never;
|
|
6948
|
-
retrieveAndGenerateConfig: RetrieveAndGenerateConfiguration;
|
|
6949
|
-
$unknown?: never;
|
|
6950
|
-
}
|
|
6951
|
-
/**
|
|
6952
|
-
* @public
|
|
6953
|
-
*/
|
|
6954
|
-
interface $UnknownMember {
|
|
6955
|
-
retrieveConfig?: never;
|
|
6956
|
-
retrieveAndGenerateConfig?: never;
|
|
6957
|
-
$unknown: [string, any];
|
|
6958
|
-
}
|
|
6959
|
-
interface Visitor<T> {
|
|
6960
|
-
retrieveConfig: (value: RetrieveConfig) => T;
|
|
6961
|
-
retrieveAndGenerateConfig: (value: RetrieveAndGenerateConfiguration) => T;
|
|
6962
|
-
_: (name: string, value: any) => T;
|
|
6963
|
-
}
|
|
6964
|
-
const visit: <T>(value: KnowledgeBaseConfig, visitor: Visitor<T>) => T;
|
|
6965
|
-
}
|
|
6966
6912
|
/**
|
|
6967
6913
|
* @internal
|
|
6968
6914
|
*/
|
|
@@ -7083,6 +7029,10 @@ export declare const StopEvaluationJobRequestFilterSensitiveLog: (obj: StopEvalu
|
|
|
7083
7029
|
* @internal
|
|
7084
7030
|
*/
|
|
7085
7031
|
export declare const GuardrailContentFilterConfigFilterSensitiveLog: (obj: GuardrailContentFilterConfig) => any;
|
|
7032
|
+
/**
|
|
7033
|
+
* @internal
|
|
7034
|
+
*/
|
|
7035
|
+
export declare const GuardrailContentFiltersTierConfigFilterSensitiveLog: (obj: GuardrailContentFiltersTierConfig) => any;
|
|
7086
7036
|
/**
|
|
7087
7037
|
* @internal
|
|
7088
7038
|
*/
|
|
@@ -7095,6 +7045,10 @@ export declare const GuardrailContextualGroundingFilterConfigFilterSensitiveLog:
|
|
|
7095
7045
|
* @internal
|
|
7096
7046
|
*/
|
|
7097
7047
|
export declare const GuardrailContextualGroundingPolicyConfigFilterSensitiveLog: (obj: GuardrailContextualGroundingPolicyConfig) => any;
|
|
7048
|
+
/**
|
|
7049
|
+
* @internal
|
|
7050
|
+
*/
|
|
7051
|
+
export declare const GuardrailTopicsTierConfigFilterSensitiveLog: (obj: GuardrailTopicsTierConfig) => any;
|
|
7098
7052
|
/**
|
|
7099
7053
|
* @internal
|
|
7100
7054
|
*/
|
|
@@ -7127,6 +7081,10 @@ export declare const CreateGuardrailVersionRequestFilterSensitiveLog: (obj: Crea
|
|
|
7127
7081
|
* @internal
|
|
7128
7082
|
*/
|
|
7129
7083
|
export declare const GuardrailContentFilterFilterSensitiveLog: (obj: GuardrailContentFilter) => any;
|
|
7084
|
+
/**
|
|
7085
|
+
* @internal
|
|
7086
|
+
*/
|
|
7087
|
+
export declare const GuardrailContentFiltersTierFilterSensitiveLog: (obj: GuardrailContentFiltersTier) => any;
|
|
7130
7088
|
/**
|
|
7131
7089
|
* @internal
|
|
7132
7090
|
*/
|
|
@@ -7139,6 +7097,10 @@ export declare const GuardrailContextualGroundingFilterFilterSensitiveLog: (obj:
|
|
|
7139
7097
|
* @internal
|
|
7140
7098
|
*/
|
|
7141
7099
|
export declare const GuardrailContextualGroundingPolicyFilterSensitiveLog: (obj: GuardrailContextualGroundingPolicy) => any;
|
|
7100
|
+
/**
|
|
7101
|
+
* @internal
|
|
7102
|
+
*/
|
|
7103
|
+
export declare const GuardrailTopicsTierFilterSensitiveLog: (obj: GuardrailTopicsTier) => any;
|
|
7142
7104
|
/**
|
|
7143
7105
|
* @internal
|
|
7144
7106
|
*/
|
|
@@ -7231,27 +7193,3 @@ export declare const GetModelCustomizationJobResponseFilterSensitiveLog: (obj: G
|
|
|
7231
7193
|
* @internal
|
|
7232
7194
|
*/
|
|
7233
7195
|
export declare const RetrievalFilterFilterSensitiveLog: (obj: RetrievalFilter) => any;
|
|
7234
|
-
/**
|
|
7235
|
-
* @internal
|
|
7236
|
-
*/
|
|
7237
|
-
export declare const KnowledgeBaseVectorSearchConfigurationFilterSensitiveLog: (obj: KnowledgeBaseVectorSearchConfiguration) => any;
|
|
7238
|
-
/**
|
|
7239
|
-
* @internal
|
|
7240
|
-
*/
|
|
7241
|
-
export declare const KnowledgeBaseRetrievalConfigurationFilterSensitiveLog: (obj: KnowledgeBaseRetrievalConfiguration) => any;
|
|
7242
|
-
/**
|
|
7243
|
-
* @internal
|
|
7244
|
-
*/
|
|
7245
|
-
export declare const KnowledgeBaseRetrieveAndGenerateConfigurationFilterSensitiveLog: (obj: KnowledgeBaseRetrieveAndGenerateConfiguration) => any;
|
|
7246
|
-
/**
|
|
7247
|
-
* @internal
|
|
7248
|
-
*/
|
|
7249
|
-
export declare const RetrieveConfigFilterSensitiveLog: (obj: RetrieveConfig) => any;
|
|
7250
|
-
/**
|
|
7251
|
-
* @internal
|
|
7252
|
-
*/
|
|
7253
|
-
export declare const RetrieveAndGenerateConfigurationFilterSensitiveLog: (obj: RetrieveAndGenerateConfiguration) => any;
|
|
7254
|
-
/**
|
|
7255
|
-
* @internal
|
|
7256
|
-
*/
|
|
7257
|
-
export declare const KnowledgeBaseConfigFilterSensitiveLog: (obj: KnowledgeBaseConfig) => any;
|
|
@@ -1,4 +1,146 @@
|
|
|
1
|
-
import { ApplicationType, EvaluationConfig, EvaluationJobStatus, EvaluationJobType, EvaluationModelConfig, EvaluationOutputDataConfig, EvaluationPrecomputedRagSourceConfig,
|
|
1
|
+
import { ApplicationType, EvaluationConfig, EvaluationJobStatus, EvaluationJobType, EvaluationModelConfig, EvaluationOutputDataConfig, EvaluationPrecomputedRagSourceConfig, ExternalSourcesRetrieveAndGenerateConfiguration, GenerationConfiguration, OrchestrationConfiguration, RetrievalFilter, RetrieveAndGenerateType, SearchType, Tag } from "./models_0";
|
|
2
|
+
/**
|
|
3
|
+
* <p>The configuration details for returning the results from the knowledge base vector search.</p>
|
|
4
|
+
* @public
|
|
5
|
+
*/
|
|
6
|
+
export interface KnowledgeBaseVectorSearchConfiguration {
|
|
7
|
+
/**
|
|
8
|
+
* <p>The number of text chunks to retrieve; the number of results to return.</p>
|
|
9
|
+
* @public
|
|
10
|
+
*/
|
|
11
|
+
numberOfResults?: number | undefined;
|
|
12
|
+
/**
|
|
13
|
+
* <p>By default, Amazon Bedrock decides a search strategy for you. If you're using an Amazon OpenSearch Serverless vector store that contains a filterable text field, you can specify whether to query the knowledge base with a <code>HYBRID</code> search using both vector embeddings and raw text, or <code>SEMANTIC</code> search using only vector embeddings. For other vector store configurations, only <code>SEMANTIC</code> search is available.</p>
|
|
14
|
+
* @public
|
|
15
|
+
*/
|
|
16
|
+
overrideSearchType?: SearchType | undefined;
|
|
17
|
+
/**
|
|
18
|
+
* <p>Specifies the filters to use on the metadata fields in the knowledge base data sources before returning results.</p>
|
|
19
|
+
* @public
|
|
20
|
+
*/
|
|
21
|
+
filter?: RetrievalFilter | undefined;
|
|
22
|
+
}
|
|
23
|
+
/**
|
|
24
|
+
* <p>Contains configuration details for retrieving information from a knowledge base.</p>
|
|
25
|
+
* @public
|
|
26
|
+
*/
|
|
27
|
+
export interface KnowledgeBaseRetrievalConfiguration {
|
|
28
|
+
/**
|
|
29
|
+
* <p>Contains configuration details for returning the results from the vector search.</p>
|
|
30
|
+
* @public
|
|
31
|
+
*/
|
|
32
|
+
vectorSearchConfiguration: KnowledgeBaseVectorSearchConfiguration | undefined;
|
|
33
|
+
}
|
|
34
|
+
/**
|
|
35
|
+
* <p>Contains configuration details for retrieving information from a knowledge base and generating responses.</p>
|
|
36
|
+
* @public
|
|
37
|
+
*/
|
|
38
|
+
export interface KnowledgeBaseRetrieveAndGenerateConfiguration {
|
|
39
|
+
/**
|
|
40
|
+
* <p>The unique identifier of the knowledge base.</p>
|
|
41
|
+
* @public
|
|
42
|
+
*/
|
|
43
|
+
knowledgeBaseId: string | undefined;
|
|
44
|
+
/**
|
|
45
|
+
* <p>The Amazon Resource Name (ARN) of the foundation model or <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/cross-region-inference.html">inference profile</a> used to generate responses.</p>
|
|
46
|
+
* @public
|
|
47
|
+
*/
|
|
48
|
+
modelArn: string | undefined;
|
|
49
|
+
/**
|
|
50
|
+
* <p>Contains configuration details for retrieving text chunks.</p>
|
|
51
|
+
* @public
|
|
52
|
+
*/
|
|
53
|
+
retrievalConfiguration?: KnowledgeBaseRetrievalConfiguration | undefined;
|
|
54
|
+
/**
|
|
55
|
+
* <p>Contains configurations details for response generation based on retrieved text chunks.</p>
|
|
56
|
+
* @public
|
|
57
|
+
*/
|
|
58
|
+
generationConfiguration?: GenerationConfiguration | undefined;
|
|
59
|
+
/**
|
|
60
|
+
* <p>Contains configuration details for the model to process the prompt prior to retrieval and response generation.</p>
|
|
61
|
+
* @public
|
|
62
|
+
*/
|
|
63
|
+
orchestrationConfiguration?: OrchestrationConfiguration | undefined;
|
|
64
|
+
}
|
|
65
|
+
/**
|
|
66
|
+
* <p>The configuration details for retrieving information from a knowledge base.</p>
|
|
67
|
+
* @public
|
|
68
|
+
*/
|
|
69
|
+
export interface RetrieveConfig {
|
|
70
|
+
/**
|
|
71
|
+
* <p>The unique identifier of the knowledge base.</p>
|
|
72
|
+
* @public
|
|
73
|
+
*/
|
|
74
|
+
knowledgeBaseId: string | undefined;
|
|
75
|
+
/**
|
|
76
|
+
* <p>Contains configuration details for knowledge base retrieval.</p>
|
|
77
|
+
* @public
|
|
78
|
+
*/
|
|
79
|
+
knowledgeBaseRetrievalConfiguration: KnowledgeBaseRetrievalConfiguration | undefined;
|
|
80
|
+
}
|
|
81
|
+
/**
|
|
82
|
+
* <p>Contains configuration details for a knowledge base retrieval and response generation.</p>
|
|
83
|
+
* @public
|
|
84
|
+
*/
|
|
85
|
+
export interface RetrieveAndGenerateConfiguration {
|
|
86
|
+
/**
|
|
87
|
+
* <p>The type of resource that contains your data for retrieving information and generating responses.</p> <p>If you choose to use <code>EXTERNAL_SOURCES</code>, then currently only Claude 3 Sonnet models for knowledge bases are supported.</p>
|
|
88
|
+
* @public
|
|
89
|
+
*/
|
|
90
|
+
type: RetrieveAndGenerateType | undefined;
|
|
91
|
+
/**
|
|
92
|
+
* <p>Contains configuration details for the knowledge base retrieval and response generation.</p>
|
|
93
|
+
* @public
|
|
94
|
+
*/
|
|
95
|
+
knowledgeBaseConfiguration?: KnowledgeBaseRetrieveAndGenerateConfiguration | undefined;
|
|
96
|
+
/**
|
|
97
|
+
* <p>The configuration for the external source wrapper object in the <code>retrieveAndGenerate</code> function.</p>
|
|
98
|
+
* @public
|
|
99
|
+
*/
|
|
100
|
+
externalSourcesConfiguration?: ExternalSourcesRetrieveAndGenerateConfiguration | undefined;
|
|
101
|
+
}
|
|
102
|
+
/**
|
|
103
|
+
* <p>The configuration details for retrieving information from a knowledge base and generating responses.</p>
|
|
104
|
+
* @public
|
|
105
|
+
*/
|
|
106
|
+
export type KnowledgeBaseConfig = KnowledgeBaseConfig.RetrieveAndGenerateConfigMember | KnowledgeBaseConfig.RetrieveConfigMember | KnowledgeBaseConfig.$UnknownMember;
|
|
107
|
+
/**
|
|
108
|
+
* @public
|
|
109
|
+
*/
|
|
110
|
+
export declare namespace KnowledgeBaseConfig {
|
|
111
|
+
/**
|
|
112
|
+
* <p>Contains configuration details for retrieving information from a knowledge base.</p>
|
|
113
|
+
* @public
|
|
114
|
+
*/
|
|
115
|
+
interface RetrieveConfigMember {
|
|
116
|
+
retrieveConfig: RetrieveConfig;
|
|
117
|
+
retrieveAndGenerateConfig?: never;
|
|
118
|
+
$unknown?: never;
|
|
119
|
+
}
|
|
120
|
+
/**
|
|
121
|
+
* <p>Contains configuration details for retrieving information from a knowledge base and generating responses.</p>
|
|
122
|
+
* @public
|
|
123
|
+
*/
|
|
124
|
+
interface RetrieveAndGenerateConfigMember {
|
|
125
|
+
retrieveConfig?: never;
|
|
126
|
+
retrieveAndGenerateConfig: RetrieveAndGenerateConfiguration;
|
|
127
|
+
$unknown?: never;
|
|
128
|
+
}
|
|
129
|
+
/**
|
|
130
|
+
* @public
|
|
131
|
+
*/
|
|
132
|
+
interface $UnknownMember {
|
|
133
|
+
retrieveConfig?: never;
|
|
134
|
+
retrieveAndGenerateConfig?: never;
|
|
135
|
+
$unknown: [string, any];
|
|
136
|
+
}
|
|
137
|
+
interface Visitor<T> {
|
|
138
|
+
retrieveConfig: (value: RetrieveConfig) => T;
|
|
139
|
+
retrieveAndGenerateConfig: (value: RetrieveAndGenerateConfiguration) => T;
|
|
140
|
+
_: (name: string, value: any) => T;
|
|
141
|
+
}
|
|
142
|
+
const visit: <T>(value: KnowledgeBaseConfig, visitor: Visitor<T>) => T;
|
|
143
|
+
}
|
|
2
144
|
/**
|
|
3
145
|
* <p>Contains configuration details for retrieval of information and response generation.</p>
|
|
4
146
|
* @public
|
|
@@ -213,6 +355,30 @@ export interface GetEvaluationJobResponse {
|
|
|
213
355
|
*/
|
|
214
356
|
failureMessages?: string[] | undefined;
|
|
215
357
|
}
|
|
358
|
+
/**
|
|
359
|
+
* @internal
|
|
360
|
+
*/
|
|
361
|
+
export declare const KnowledgeBaseVectorSearchConfigurationFilterSensitiveLog: (obj: KnowledgeBaseVectorSearchConfiguration) => any;
|
|
362
|
+
/**
|
|
363
|
+
* @internal
|
|
364
|
+
*/
|
|
365
|
+
export declare const KnowledgeBaseRetrievalConfigurationFilterSensitiveLog: (obj: KnowledgeBaseRetrievalConfiguration) => any;
|
|
366
|
+
/**
|
|
367
|
+
* @internal
|
|
368
|
+
*/
|
|
369
|
+
export declare const KnowledgeBaseRetrieveAndGenerateConfigurationFilterSensitiveLog: (obj: KnowledgeBaseRetrieveAndGenerateConfiguration) => any;
|
|
370
|
+
/**
|
|
371
|
+
* @internal
|
|
372
|
+
*/
|
|
373
|
+
export declare const RetrieveConfigFilterSensitiveLog: (obj: RetrieveConfig) => any;
|
|
374
|
+
/**
|
|
375
|
+
* @internal
|
|
376
|
+
*/
|
|
377
|
+
export declare const RetrieveAndGenerateConfigurationFilterSensitiveLog: (obj: RetrieveAndGenerateConfiguration) => any;
|
|
378
|
+
/**
|
|
379
|
+
* @internal
|
|
380
|
+
*/
|
|
381
|
+
export declare const KnowledgeBaseConfigFilterSensitiveLog: (obj: KnowledgeBaseConfig) => any;
|
|
216
382
|
/**
|
|
217
383
|
* @internal
|
|
218
384
|
*/
|