@aws-sdk/client-bedrock 3.839.0 → 3.840.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/auth/httpAuthSchemeProvider.js +17 -0
- package/dist-cjs/index.js +152 -20
- package/dist-cjs/runtimeConfig.js +23 -0
- package/dist-cjs/runtimeConfig.shared.js +6 -0
- package/dist-es/BedrockClient.js +1 -0
- package/dist-es/auth/httpAuthExtensionConfiguration.js +8 -0
- package/dist-es/auth/httpAuthSchemeProvider.js +17 -0
- package/dist-es/models/models_0.js +56 -12
- package/dist-es/models/models_1.js +19 -1
- package/dist-es/protocols/Aws_restJson1.js +42 -0
- package/dist-es/runtimeConfig.js +24 -1
- package/dist-es/runtimeConfig.shared.js +6 -0
- package/dist-types/auth/httpAuthExtensionConfiguration.d.ts +4 -1
- package/dist-types/auth/httpAuthSchemeProvider.d.ts +9 -1
- package/dist-types/commands/CreateEvaluationJobCommand.d.ts +76 -6
- package/dist-types/commands/GetEvaluationJobCommand.d.ts +76 -6
- package/dist-types/commands/GetFoundationModelAvailabilityCommand.d.ts +2 -1
- package/dist-types/commands/ListFoundationModelAgreementOffersCommand.d.ts +1 -2
- package/dist-types/models/models_0.d.ts +220 -177
- package/dist-types/models/models_1.d.ts +188 -1
- package/dist-types/runtimeConfig.browser.d.ts +10 -1
- package/dist-types/runtimeConfig.d.ts +13 -1
- package/dist-types/runtimeConfig.native.d.ts +10 -1
- package/dist-types/runtimeConfig.shared.d.ts +12 -1
- package/dist-types/ts3.4/auth/httpAuthExtensionConfiguration.d.ts +5 -0
- package/dist-types/ts3.4/auth/httpAuthSchemeProvider.d.ts +4 -0
- package/dist-types/ts3.4/commands/GetFoundationModelAvailabilityCommand.d.ts +2 -4
- package/dist-types/ts3.4/commands/ListFoundationModelAgreementOffersCommand.d.ts +4 -2
- package/dist-types/ts3.4/models/models_0.d.ts +101 -52
- package/dist-types/ts3.4/models/models_1.d.ts +58 -1
- package/dist-types/ts3.4/runtimeConfig.browser.d.ts +27 -1
- package/dist-types/ts3.4/runtimeConfig.d.ts +30 -1
- package/dist-types/ts3.4/runtimeConfig.native.d.ts +27 -1
- package/dist-types/ts3.4/runtimeConfig.shared.d.ts +27 -1
- package/package.json +13 -12
|
@@ -2019,6 +2019,57 @@ export interface FilterAttribute {
|
|
|
2019
2019
|
*/
|
|
2020
2020
|
value: __DocumentType | undefined;
|
|
2021
2021
|
}
|
|
2022
|
+
/**
|
|
2023
|
+
* @public
|
|
2024
|
+
* @enum
|
|
2025
|
+
*/
|
|
2026
|
+
export declare const AttributeType: {
|
|
2027
|
+
readonly BOOLEAN: "BOOLEAN";
|
|
2028
|
+
readonly NUMBER: "NUMBER";
|
|
2029
|
+
readonly STRING: "STRING";
|
|
2030
|
+
readonly STRING_LIST: "STRING_LIST";
|
|
2031
|
+
};
|
|
2032
|
+
/**
|
|
2033
|
+
* @public
|
|
2034
|
+
*/
|
|
2035
|
+
export type AttributeType = (typeof AttributeType)[keyof typeof AttributeType];
|
|
2036
|
+
/**
|
|
2037
|
+
* <p>Defines the schema for a metadata attribute used in Knowledge Base vector searches. Metadata attributes provide additional context for documents and can be used for filtering and reranking search results.</p>
|
|
2038
|
+
* @public
|
|
2039
|
+
*/
|
|
2040
|
+
export interface MetadataAttributeSchema {
|
|
2041
|
+
/**
|
|
2042
|
+
* <p>The unique identifier for the metadata attribute. This key is used to reference the attribute in filter expressions and reranking configurations.</p>
|
|
2043
|
+
* @public
|
|
2044
|
+
*/
|
|
2045
|
+
key: string | undefined;
|
|
2046
|
+
/**
|
|
2047
|
+
* <p>The data type of the metadata attribute. The type determines how the attribute can be used in filter expressions and reranking.</p>
|
|
2048
|
+
* @public
|
|
2049
|
+
*/
|
|
2050
|
+
type: AttributeType | undefined;
|
|
2051
|
+
/**
|
|
2052
|
+
* <p>An optional description of the metadata attribute that provides additional context about its purpose and usage.</p>
|
|
2053
|
+
* @public
|
|
2054
|
+
*/
|
|
2055
|
+
description: string | undefined;
|
|
2056
|
+
}
|
|
2057
|
+
/**
|
|
2058
|
+
* <p>Configuration for implicit filtering in Knowledge Base vector searches. Implicit filtering allows you to automatically filter search results based on metadata attributes without requiring explicit filter expressions in each query.</p>
|
|
2059
|
+
* @public
|
|
2060
|
+
*/
|
|
2061
|
+
export interface ImplicitFilterConfiguration {
|
|
2062
|
+
/**
|
|
2063
|
+
* <p>A list of metadata attribute schemas that define the structure and properties of metadata fields used for implicit filtering. Each attribute defines a key, type, and optional description.</p>
|
|
2064
|
+
* @public
|
|
2065
|
+
*/
|
|
2066
|
+
metadataAttributes: MetadataAttributeSchema[] | undefined;
|
|
2067
|
+
/**
|
|
2068
|
+
* <p>The Amazon Resource Name (ARN) of the foundation model used for implicit filtering. This model processes the query to extract relevant filtering criteria.</p>
|
|
2069
|
+
* @public
|
|
2070
|
+
*/
|
|
2071
|
+
modelArn: string | undefined;
|
|
2072
|
+
}
|
|
2022
2073
|
/**
|
|
2023
2074
|
* @public
|
|
2024
2075
|
* @enum
|
|
@@ -2031,6 +2082,151 @@ export declare const SearchType: {
|
|
|
2031
2082
|
* @public
|
|
2032
2083
|
*/
|
|
2033
2084
|
export type SearchType = (typeof SearchType)[keyof typeof SearchType];
|
|
2085
|
+
/**
|
|
2086
|
+
* @public
|
|
2087
|
+
* @enum
|
|
2088
|
+
*/
|
|
2089
|
+
export declare const RerankingMetadataSelectionMode: {
|
|
2090
|
+
readonly ALL: "ALL";
|
|
2091
|
+
readonly SELECTIVE: "SELECTIVE";
|
|
2092
|
+
};
|
|
2093
|
+
/**
|
|
2094
|
+
* @public
|
|
2095
|
+
*/
|
|
2096
|
+
export type RerankingMetadataSelectionMode = (typeof RerankingMetadataSelectionMode)[keyof typeof RerankingMetadataSelectionMode];
|
|
2097
|
+
/**
|
|
2098
|
+
* <p>Specifies a field to be used during the reranking process in a Knowledge Base vector search. This structure identifies metadata fields that should be considered when reordering search results to improve relevance.</p>
|
|
2099
|
+
* @public
|
|
2100
|
+
*/
|
|
2101
|
+
export interface FieldForReranking {
|
|
2102
|
+
/**
|
|
2103
|
+
* <p>The name of the metadata field to be used during the reranking process.</p>
|
|
2104
|
+
* @public
|
|
2105
|
+
*/
|
|
2106
|
+
fieldName: string | undefined;
|
|
2107
|
+
}
|
|
2108
|
+
/**
|
|
2109
|
+
* <p>Configuration for selectively including or excluding metadata fields during the reranking process. This allows you to control which metadata attributes are considered when reordering search results.</p>
|
|
2110
|
+
* @public
|
|
2111
|
+
*/
|
|
2112
|
+
export type RerankingMetadataSelectiveModeConfiguration = RerankingMetadataSelectiveModeConfiguration.FieldsToExcludeMember | RerankingMetadataSelectiveModeConfiguration.FieldsToIncludeMember | RerankingMetadataSelectiveModeConfiguration.$UnknownMember;
|
|
2113
|
+
/**
|
|
2114
|
+
* @public
|
|
2115
|
+
*/
|
|
2116
|
+
export declare namespace RerankingMetadataSelectiveModeConfiguration {
|
|
2117
|
+
/**
|
|
2118
|
+
* <p>A list of metadata field names to explicitly include in the reranking process. Only these fields will be considered when reordering search results. This parameter cannot be used together with fieldsToExclude.</p>
|
|
2119
|
+
* @public
|
|
2120
|
+
*/
|
|
2121
|
+
interface FieldsToIncludeMember {
|
|
2122
|
+
fieldsToInclude: FieldForReranking[];
|
|
2123
|
+
fieldsToExclude?: never;
|
|
2124
|
+
$unknown?: never;
|
|
2125
|
+
}
|
|
2126
|
+
/**
|
|
2127
|
+
* <p>A list of metadata field names to explicitly exclude from the reranking process. All metadata fields except these will be considered when reordering search results. This parameter cannot be used together with fieldsToInclude.</p>
|
|
2128
|
+
* @public
|
|
2129
|
+
*/
|
|
2130
|
+
interface FieldsToExcludeMember {
|
|
2131
|
+
fieldsToInclude?: never;
|
|
2132
|
+
fieldsToExclude: FieldForReranking[];
|
|
2133
|
+
$unknown?: never;
|
|
2134
|
+
}
|
|
2135
|
+
/**
|
|
2136
|
+
* @public
|
|
2137
|
+
*/
|
|
2138
|
+
interface $UnknownMember {
|
|
2139
|
+
fieldsToInclude?: never;
|
|
2140
|
+
fieldsToExclude?: never;
|
|
2141
|
+
$unknown: [string, any];
|
|
2142
|
+
}
|
|
2143
|
+
interface Visitor<T> {
|
|
2144
|
+
fieldsToInclude: (value: FieldForReranking[]) => T;
|
|
2145
|
+
fieldsToExclude: (value: FieldForReranking[]) => T;
|
|
2146
|
+
_: (name: string, value: any) => T;
|
|
2147
|
+
}
|
|
2148
|
+
const visit: <T>(value: RerankingMetadataSelectiveModeConfiguration, visitor: Visitor<T>) => T;
|
|
2149
|
+
}
|
|
2150
|
+
/**
|
|
2151
|
+
* <p>Configuration for how metadata should be used during the reranking process in Knowledge Base vector searches. This determines which metadata fields are included or excluded when reordering search results.</p>
|
|
2152
|
+
* @public
|
|
2153
|
+
*/
|
|
2154
|
+
export interface MetadataConfigurationForReranking {
|
|
2155
|
+
/**
|
|
2156
|
+
* <p>The mode for selecting which metadata fields to include in the reranking process. Valid values are ALL (use all available metadata fields) or SELECTIVE (use only specified fields).</p>
|
|
2157
|
+
* @public
|
|
2158
|
+
*/
|
|
2159
|
+
selectionMode: RerankingMetadataSelectionMode | undefined;
|
|
2160
|
+
/**
|
|
2161
|
+
* <p>Configuration for selective mode, which allows you to explicitly include or exclude specific metadata fields during reranking. This is only used when selectionMode is set to SELECTIVE.</p>
|
|
2162
|
+
* @public
|
|
2163
|
+
*/
|
|
2164
|
+
selectiveModeConfiguration?: RerankingMetadataSelectiveModeConfiguration | undefined;
|
|
2165
|
+
}
|
|
2166
|
+
/**
|
|
2167
|
+
* <p>Configuration for the Amazon Bedrock foundation model used for reranking vector search results. This specifies which model to use and any additional parameters required by the model.</p>
|
|
2168
|
+
* @public
|
|
2169
|
+
*/
|
|
2170
|
+
export interface VectorSearchBedrockRerankingModelConfiguration {
|
|
2171
|
+
/**
|
|
2172
|
+
* <p>The Amazon Resource Name (ARN) of the foundation model to use for reranking. This model processes the query and search results to determine a more relevant ordering.</p>
|
|
2173
|
+
* @public
|
|
2174
|
+
*/
|
|
2175
|
+
modelArn: string | undefined;
|
|
2176
|
+
/**
|
|
2177
|
+
* <p>A list of additional fields to include in the model request during reranking. These fields provide extra context or configuration options specific to the selected foundation model.</p>
|
|
2178
|
+
* @public
|
|
2179
|
+
*/
|
|
2180
|
+
additionalModelRequestFields?: Record<string, __DocumentType> | undefined;
|
|
2181
|
+
}
|
|
2182
|
+
/**
|
|
2183
|
+
* <p>Configuration for using Amazon Bedrock foundation models to rerank Knowledge Base vector search results. This enables more sophisticated relevance ranking using large language models.</p>
|
|
2184
|
+
* @public
|
|
2185
|
+
*/
|
|
2186
|
+
export interface VectorSearchBedrockRerankingConfiguration {
|
|
2187
|
+
/**
|
|
2188
|
+
* <p>Configuration for the Amazon Bedrock foundation model used for reranking. This includes the model ARN and any additional request fields required by the model.</p>
|
|
2189
|
+
* @public
|
|
2190
|
+
*/
|
|
2191
|
+
modelConfiguration: VectorSearchBedrockRerankingModelConfiguration | undefined;
|
|
2192
|
+
/**
|
|
2193
|
+
* <p>The maximum number of results to rerank. This limits how many of the initial vector search results will be processed by the reranking model. A smaller number improves performance but may exclude potentially relevant results.</p>
|
|
2194
|
+
* @public
|
|
2195
|
+
*/
|
|
2196
|
+
numberOfRerankedResults?: number | undefined;
|
|
2197
|
+
/**
|
|
2198
|
+
* <p>Configuration for how document metadata should be used during the reranking process. This determines which metadata fields are included when reordering search results.</p>
|
|
2199
|
+
* @public
|
|
2200
|
+
*/
|
|
2201
|
+
metadataConfiguration?: MetadataConfigurationForReranking | undefined;
|
|
2202
|
+
}
|
|
2203
|
+
/**
|
|
2204
|
+
* @public
|
|
2205
|
+
* @enum
|
|
2206
|
+
*/
|
|
2207
|
+
export declare const VectorSearchRerankingConfigurationType: {
|
|
2208
|
+
readonly BEDROCK_RERANKING_MODEL: "BEDROCK_RERANKING_MODEL";
|
|
2209
|
+
};
|
|
2210
|
+
/**
|
|
2211
|
+
* @public
|
|
2212
|
+
*/
|
|
2213
|
+
export type VectorSearchRerankingConfigurationType = (typeof VectorSearchRerankingConfigurationType)[keyof typeof VectorSearchRerankingConfigurationType];
|
|
2214
|
+
/**
|
|
2215
|
+
* <p>Configuration for reranking vector search results to improve relevance. Reranking applies additional relevance models to reorder the initial vector search results based on more sophisticated criteria.</p>
|
|
2216
|
+
* @public
|
|
2217
|
+
*/
|
|
2218
|
+
export interface VectorSearchRerankingConfiguration {
|
|
2219
|
+
/**
|
|
2220
|
+
* <p>The type of reranking to apply to vector search results. Currently, the only supported value is BEDROCK, which uses Amazon Bedrock foundation models for reranking.</p>
|
|
2221
|
+
* @public
|
|
2222
|
+
*/
|
|
2223
|
+
type: VectorSearchRerankingConfigurationType | undefined;
|
|
2224
|
+
/**
|
|
2225
|
+
* <p>Configuration for using Amazon Bedrock foundation models to rerank search results. This is required when the reranking type is set to BEDROCK.</p>
|
|
2226
|
+
* @public
|
|
2227
|
+
*/
|
|
2228
|
+
bedrockRerankingConfiguration?: VectorSearchBedrockRerankingConfiguration | undefined;
|
|
2229
|
+
}
|
|
2034
2230
|
/**
|
|
2035
2231
|
* @public
|
|
2036
2232
|
* @enum
|
|
@@ -6179,183 +6375,6 @@ export declare const AuthorizationStatus: {
|
|
|
6179
6375
|
* @public
|
|
6180
6376
|
*/
|
|
6181
6377
|
export type AuthorizationStatus = (typeof AuthorizationStatus)[keyof typeof AuthorizationStatus];
|
|
6182
|
-
/**
|
|
6183
|
-
* @public
|
|
6184
|
-
* @enum
|
|
6185
|
-
*/
|
|
6186
|
-
export declare const EntitlementAvailability: {
|
|
6187
|
-
readonly AVAILABLE: "AVAILABLE";
|
|
6188
|
-
readonly NOT_AVAILABLE: "NOT_AVAILABLE";
|
|
6189
|
-
};
|
|
6190
|
-
/**
|
|
6191
|
-
* @public
|
|
6192
|
-
*/
|
|
6193
|
-
export type EntitlementAvailability = (typeof EntitlementAvailability)[keyof typeof EntitlementAvailability];
|
|
6194
|
-
/**
|
|
6195
|
-
* @public
|
|
6196
|
-
* @enum
|
|
6197
|
-
*/
|
|
6198
|
-
export declare const RegionAvailability: {
|
|
6199
|
-
readonly AVAILABLE: "AVAILABLE";
|
|
6200
|
-
readonly NOT_AVAILABLE: "NOT_AVAILABLE";
|
|
6201
|
-
};
|
|
6202
|
-
/**
|
|
6203
|
-
* @public
|
|
6204
|
-
*/
|
|
6205
|
-
export type RegionAvailability = (typeof RegionAvailability)[keyof typeof RegionAvailability];
|
|
6206
|
-
/**
|
|
6207
|
-
* @public
|
|
6208
|
-
*/
|
|
6209
|
-
export interface GetFoundationModelAvailabilityResponse {
|
|
6210
|
-
/**
|
|
6211
|
-
* <p>The model Id of the foundation model.</p>
|
|
6212
|
-
* @public
|
|
6213
|
-
*/
|
|
6214
|
-
modelId: string | undefined;
|
|
6215
|
-
/**
|
|
6216
|
-
* <p>Agreement availability. </p>
|
|
6217
|
-
* @public
|
|
6218
|
-
*/
|
|
6219
|
-
agreementAvailability: AgreementAvailability | undefined;
|
|
6220
|
-
/**
|
|
6221
|
-
* <p>Authorization status.</p>
|
|
6222
|
-
* @public
|
|
6223
|
-
*/
|
|
6224
|
-
authorizationStatus: AuthorizationStatus | undefined;
|
|
6225
|
-
/**
|
|
6226
|
-
* <p>Entitlement availability. </p>
|
|
6227
|
-
* @public
|
|
6228
|
-
*/
|
|
6229
|
-
entitlementAvailability: EntitlementAvailability | undefined;
|
|
6230
|
-
/**
|
|
6231
|
-
* <p>Region availability. </p>
|
|
6232
|
-
* @public
|
|
6233
|
-
*/
|
|
6234
|
-
regionAvailability: RegionAvailability | undefined;
|
|
6235
|
-
}
|
|
6236
|
-
/**
|
|
6237
|
-
* @public
|
|
6238
|
-
* @enum
|
|
6239
|
-
*/
|
|
6240
|
-
export declare const OfferType: {
|
|
6241
|
-
readonly ALL: "ALL";
|
|
6242
|
-
readonly PUBLIC: "PUBLIC";
|
|
6243
|
-
};
|
|
6244
|
-
/**
|
|
6245
|
-
* @public
|
|
6246
|
-
*/
|
|
6247
|
-
export type OfferType = (typeof OfferType)[keyof typeof OfferType];
|
|
6248
|
-
/**
|
|
6249
|
-
* @public
|
|
6250
|
-
*/
|
|
6251
|
-
export interface ListFoundationModelAgreementOffersRequest {
|
|
6252
|
-
/**
|
|
6253
|
-
* <p>Model Id of the foundation model.</p>
|
|
6254
|
-
* @public
|
|
6255
|
-
*/
|
|
6256
|
-
modelId: string | undefined;
|
|
6257
|
-
/**
|
|
6258
|
-
* <p>Type of offer associated with the model.</p>
|
|
6259
|
-
* @public
|
|
6260
|
-
*/
|
|
6261
|
-
offerType?: OfferType | undefined;
|
|
6262
|
-
}
|
|
6263
|
-
/**
|
|
6264
|
-
* <p>The legal term of the agreement.</p>
|
|
6265
|
-
* @public
|
|
6266
|
-
*/
|
|
6267
|
-
export interface LegalTerm {
|
|
6268
|
-
/**
|
|
6269
|
-
* <p>URL to the legal term document.</p>
|
|
6270
|
-
* @public
|
|
6271
|
-
*/
|
|
6272
|
-
url?: string | undefined;
|
|
6273
|
-
}
|
|
6274
|
-
/**
|
|
6275
|
-
* <p>Describes a support term.</p>
|
|
6276
|
-
* @public
|
|
6277
|
-
*/
|
|
6278
|
-
export interface SupportTerm {
|
|
6279
|
-
/**
|
|
6280
|
-
* <p>Describes the refund policy.</p>
|
|
6281
|
-
* @public
|
|
6282
|
-
*/
|
|
6283
|
-
refundPolicyDescription?: string | undefined;
|
|
6284
|
-
}
|
|
6285
|
-
/**
|
|
6286
|
-
* <p>Dimensional price rate.</p>
|
|
6287
|
-
* @public
|
|
6288
|
-
*/
|
|
6289
|
-
export interface DimensionalPriceRate {
|
|
6290
|
-
/**
|
|
6291
|
-
* <p>Dimension for the price rate.</p>
|
|
6292
|
-
* @public
|
|
6293
|
-
*/
|
|
6294
|
-
dimension?: string | undefined;
|
|
6295
|
-
/**
|
|
6296
|
-
* <p>Single-dimensional rate information.</p>
|
|
6297
|
-
* @public
|
|
6298
|
-
*/
|
|
6299
|
-
price?: string | undefined;
|
|
6300
|
-
/**
|
|
6301
|
-
* <p>Description of the price rate.</p>
|
|
6302
|
-
* @public
|
|
6303
|
-
*/
|
|
6304
|
-
description?: string | undefined;
|
|
6305
|
-
/**
|
|
6306
|
-
* <p>Unit associated with the price.</p>
|
|
6307
|
-
* @public
|
|
6308
|
-
*/
|
|
6309
|
-
unit?: string | undefined;
|
|
6310
|
-
}
|
|
6311
|
-
/**
|
|
6312
|
-
* <p>Describes the usage-based pricing term.</p>
|
|
6313
|
-
* @public
|
|
6314
|
-
*/
|
|
6315
|
-
export interface PricingTerm {
|
|
6316
|
-
/**
|
|
6317
|
-
* <p>Describes a usage price for each dimension.</p>
|
|
6318
|
-
* @public
|
|
6319
|
-
*/
|
|
6320
|
-
rateCard: DimensionalPriceRate[] | undefined;
|
|
6321
|
-
}
|
|
6322
|
-
/**
|
|
6323
|
-
* <p>Describes the validity terms.</p>
|
|
6324
|
-
* @public
|
|
6325
|
-
*/
|
|
6326
|
-
export interface ValidityTerm {
|
|
6327
|
-
/**
|
|
6328
|
-
* <p>Describes the agreement duration.</p>
|
|
6329
|
-
* @public
|
|
6330
|
-
*/
|
|
6331
|
-
agreementDuration?: string | undefined;
|
|
6332
|
-
}
|
|
6333
|
-
/**
|
|
6334
|
-
* <p>Describes the usage terms of an offer.</p>
|
|
6335
|
-
* @public
|
|
6336
|
-
*/
|
|
6337
|
-
export interface TermDetails {
|
|
6338
|
-
/**
|
|
6339
|
-
* <p>Describes the usage-based pricing term.</p>
|
|
6340
|
-
* @public
|
|
6341
|
-
*/
|
|
6342
|
-
usageBasedPricingTerm: PricingTerm | undefined;
|
|
6343
|
-
/**
|
|
6344
|
-
* <p>Describes the legal terms.</p>
|
|
6345
|
-
* @public
|
|
6346
|
-
*/
|
|
6347
|
-
legalTerm: LegalTerm | undefined;
|
|
6348
|
-
/**
|
|
6349
|
-
* <p>Describes the support terms.</p>
|
|
6350
|
-
* @public
|
|
6351
|
-
*/
|
|
6352
|
-
supportTerm: SupportTerm | undefined;
|
|
6353
|
-
/**
|
|
6354
|
-
* <p>Describes the validity terms.</p>
|
|
6355
|
-
* @public
|
|
6356
|
-
*/
|
|
6357
|
-
validityTerm?: ValidityTerm | undefined;
|
|
6358
|
-
}
|
|
6359
6378
|
/**
|
|
6360
6379
|
* @internal
|
|
6361
6380
|
*/
|
|
@@ -6464,6 +6483,30 @@ export declare const ExternalSourcesRetrieveAndGenerateConfigurationFilterSensit
|
|
|
6464
6483
|
* @internal
|
|
6465
6484
|
*/
|
|
6466
6485
|
export declare const GenerationConfigurationFilterSensitiveLog: (obj: GenerationConfiguration) => any;
|
|
6486
|
+
/**
|
|
6487
|
+
* @internal
|
|
6488
|
+
*/
|
|
6489
|
+
export declare const MetadataAttributeSchemaFilterSensitiveLog: (obj: MetadataAttributeSchema) => any;
|
|
6490
|
+
/**
|
|
6491
|
+
* @internal
|
|
6492
|
+
*/
|
|
6493
|
+
export declare const ImplicitFilterConfigurationFilterSensitiveLog: (obj: ImplicitFilterConfiguration) => any;
|
|
6494
|
+
/**
|
|
6495
|
+
* @internal
|
|
6496
|
+
*/
|
|
6497
|
+
export declare const RerankingMetadataSelectiveModeConfigurationFilterSensitiveLog: (obj: RerankingMetadataSelectiveModeConfiguration) => any;
|
|
6498
|
+
/**
|
|
6499
|
+
* @internal
|
|
6500
|
+
*/
|
|
6501
|
+
export declare const MetadataConfigurationForRerankingFilterSensitiveLog: (obj: MetadataConfigurationForReranking) => any;
|
|
6502
|
+
/**
|
|
6503
|
+
* @internal
|
|
6504
|
+
*/
|
|
6505
|
+
export declare const VectorSearchBedrockRerankingConfigurationFilterSensitiveLog: (obj: VectorSearchBedrockRerankingConfiguration) => any;
|
|
6506
|
+
/**
|
|
6507
|
+
* @internal
|
|
6508
|
+
*/
|
|
6509
|
+
export declare const VectorSearchRerankingConfigurationFilterSensitiveLog: (obj: VectorSearchRerankingConfiguration) => any;
|
|
6467
6510
|
/**
|
|
6468
6511
|
* @internal
|
|
6469
6512
|
*/
|
|
@@ -1,4 +1,181 @@
|
|
|
1
|
-
import { ApplicationType, CustomizationConfig, CustomizationType, EvaluationConfig, EvaluationJobStatus, EvaluationJobType, EvaluationModelConfig, EvaluationOutputDataConfig, EvaluationPrecomputedRagSourceConfig, ExternalSourcesRetrieveAndGenerateConfiguration, FilterAttribute, GenerationConfiguration, OrchestrationConfiguration, OutputDataConfig, RetrieveAndGenerateType, SearchType, SortJobsBy, SortOrder, Tag,
|
|
1
|
+
import { AgreementAvailability, ApplicationType, AuthorizationStatus, CustomizationConfig, CustomizationType, EvaluationConfig, EvaluationJobStatus, EvaluationJobType, EvaluationModelConfig, EvaluationOutputDataConfig, EvaluationPrecomputedRagSourceConfig, ExternalSourcesRetrieveAndGenerateConfiguration, FilterAttribute, GenerationConfiguration, ImplicitFilterConfiguration, OrchestrationConfiguration, OutputDataConfig, RetrieveAndGenerateType, SearchType, SortJobsBy, SortOrder, Tag, TrainingDataConfig, TrainingMetrics, ValidationDataConfig, ValidatorMetric, VectorSearchRerankingConfiguration, VpcConfig } from "./models_0";
|
|
2
|
+
/**
|
|
3
|
+
* @public
|
|
4
|
+
* @enum
|
|
5
|
+
*/
|
|
6
|
+
export declare const EntitlementAvailability: {
|
|
7
|
+
readonly AVAILABLE: "AVAILABLE";
|
|
8
|
+
readonly NOT_AVAILABLE: "NOT_AVAILABLE";
|
|
9
|
+
};
|
|
10
|
+
/**
|
|
11
|
+
* @public
|
|
12
|
+
*/
|
|
13
|
+
export type EntitlementAvailability = (typeof EntitlementAvailability)[keyof typeof EntitlementAvailability];
|
|
14
|
+
/**
|
|
15
|
+
* @public
|
|
16
|
+
* @enum
|
|
17
|
+
*/
|
|
18
|
+
export declare const RegionAvailability: {
|
|
19
|
+
readonly AVAILABLE: "AVAILABLE";
|
|
20
|
+
readonly NOT_AVAILABLE: "NOT_AVAILABLE";
|
|
21
|
+
};
|
|
22
|
+
/**
|
|
23
|
+
* @public
|
|
24
|
+
*/
|
|
25
|
+
export type RegionAvailability = (typeof RegionAvailability)[keyof typeof RegionAvailability];
|
|
26
|
+
/**
|
|
27
|
+
* @public
|
|
28
|
+
*/
|
|
29
|
+
export interface GetFoundationModelAvailabilityResponse {
|
|
30
|
+
/**
|
|
31
|
+
* <p>The model Id of the foundation model.</p>
|
|
32
|
+
* @public
|
|
33
|
+
*/
|
|
34
|
+
modelId: string | undefined;
|
|
35
|
+
/**
|
|
36
|
+
* <p>Agreement availability. </p>
|
|
37
|
+
* @public
|
|
38
|
+
*/
|
|
39
|
+
agreementAvailability: AgreementAvailability | undefined;
|
|
40
|
+
/**
|
|
41
|
+
* <p>Authorization status.</p>
|
|
42
|
+
* @public
|
|
43
|
+
*/
|
|
44
|
+
authorizationStatus: AuthorizationStatus | undefined;
|
|
45
|
+
/**
|
|
46
|
+
* <p>Entitlement availability. </p>
|
|
47
|
+
* @public
|
|
48
|
+
*/
|
|
49
|
+
entitlementAvailability: EntitlementAvailability | undefined;
|
|
50
|
+
/**
|
|
51
|
+
* <p>Region availability. </p>
|
|
52
|
+
* @public
|
|
53
|
+
*/
|
|
54
|
+
regionAvailability: RegionAvailability | undefined;
|
|
55
|
+
}
|
|
56
|
+
/**
|
|
57
|
+
* @public
|
|
58
|
+
* @enum
|
|
59
|
+
*/
|
|
60
|
+
export declare const OfferType: {
|
|
61
|
+
readonly ALL: "ALL";
|
|
62
|
+
readonly PUBLIC: "PUBLIC";
|
|
63
|
+
};
|
|
64
|
+
/**
|
|
65
|
+
* @public
|
|
66
|
+
*/
|
|
67
|
+
export type OfferType = (typeof OfferType)[keyof typeof OfferType];
|
|
68
|
+
/**
|
|
69
|
+
* @public
|
|
70
|
+
*/
|
|
71
|
+
export interface ListFoundationModelAgreementOffersRequest {
|
|
72
|
+
/**
|
|
73
|
+
* <p>Model Id of the foundation model.</p>
|
|
74
|
+
* @public
|
|
75
|
+
*/
|
|
76
|
+
modelId: string | undefined;
|
|
77
|
+
/**
|
|
78
|
+
* <p>Type of offer associated with the model.</p>
|
|
79
|
+
* @public
|
|
80
|
+
*/
|
|
81
|
+
offerType?: OfferType | undefined;
|
|
82
|
+
}
|
|
83
|
+
/**
|
|
84
|
+
* <p>The legal term of the agreement.</p>
|
|
85
|
+
* @public
|
|
86
|
+
*/
|
|
87
|
+
export interface LegalTerm {
|
|
88
|
+
/**
|
|
89
|
+
* <p>URL to the legal term document.</p>
|
|
90
|
+
* @public
|
|
91
|
+
*/
|
|
92
|
+
url?: string | undefined;
|
|
93
|
+
}
|
|
94
|
+
/**
|
|
95
|
+
* <p>Describes a support term.</p>
|
|
96
|
+
* @public
|
|
97
|
+
*/
|
|
98
|
+
export interface SupportTerm {
|
|
99
|
+
/**
|
|
100
|
+
* <p>Describes the refund policy.</p>
|
|
101
|
+
* @public
|
|
102
|
+
*/
|
|
103
|
+
refundPolicyDescription?: string | undefined;
|
|
104
|
+
}
|
|
105
|
+
/**
|
|
106
|
+
* <p>Dimensional price rate.</p>
|
|
107
|
+
* @public
|
|
108
|
+
*/
|
|
109
|
+
export interface DimensionalPriceRate {
|
|
110
|
+
/**
|
|
111
|
+
* <p>Dimension for the price rate.</p>
|
|
112
|
+
* @public
|
|
113
|
+
*/
|
|
114
|
+
dimension?: string | undefined;
|
|
115
|
+
/**
|
|
116
|
+
* <p>Single-dimensional rate information.</p>
|
|
117
|
+
* @public
|
|
118
|
+
*/
|
|
119
|
+
price?: string | undefined;
|
|
120
|
+
/**
|
|
121
|
+
* <p>Description of the price rate.</p>
|
|
122
|
+
* @public
|
|
123
|
+
*/
|
|
124
|
+
description?: string | undefined;
|
|
125
|
+
/**
|
|
126
|
+
* <p>Unit associated with the price.</p>
|
|
127
|
+
* @public
|
|
128
|
+
*/
|
|
129
|
+
unit?: string | undefined;
|
|
130
|
+
}
|
|
131
|
+
/**
|
|
132
|
+
* <p>Describes the usage-based pricing term.</p>
|
|
133
|
+
* @public
|
|
134
|
+
*/
|
|
135
|
+
export interface PricingTerm {
|
|
136
|
+
/**
|
|
137
|
+
* <p>Describes a usage price for each dimension.</p>
|
|
138
|
+
* @public
|
|
139
|
+
*/
|
|
140
|
+
rateCard: DimensionalPriceRate[] | undefined;
|
|
141
|
+
}
|
|
142
|
+
/**
|
|
143
|
+
* <p>Describes the validity terms.</p>
|
|
144
|
+
* @public
|
|
145
|
+
*/
|
|
146
|
+
export interface ValidityTerm {
|
|
147
|
+
/**
|
|
148
|
+
* <p>Describes the agreement duration.</p>
|
|
149
|
+
* @public
|
|
150
|
+
*/
|
|
151
|
+
agreementDuration?: string | undefined;
|
|
152
|
+
}
|
|
153
|
+
/**
|
|
154
|
+
* <p>Describes the usage terms of an offer.</p>
|
|
155
|
+
* @public
|
|
156
|
+
*/
|
|
157
|
+
export interface TermDetails {
|
|
158
|
+
/**
|
|
159
|
+
* <p>Describes the usage-based pricing term.</p>
|
|
160
|
+
* @public
|
|
161
|
+
*/
|
|
162
|
+
usageBasedPricingTerm: PricingTerm | undefined;
|
|
163
|
+
/**
|
|
164
|
+
* <p>Describes the legal terms.</p>
|
|
165
|
+
* @public
|
|
166
|
+
*/
|
|
167
|
+
legalTerm: LegalTerm | undefined;
|
|
168
|
+
/**
|
|
169
|
+
* <p>Describes the support terms.</p>
|
|
170
|
+
* @public
|
|
171
|
+
*/
|
|
172
|
+
supportTerm: SupportTerm | undefined;
|
|
173
|
+
/**
|
|
174
|
+
* <p>Describes the validity terms.</p>
|
|
175
|
+
* @public
|
|
176
|
+
*/
|
|
177
|
+
validityTerm?: ValidityTerm | undefined;
|
|
178
|
+
}
|
|
2
179
|
/**
|
|
3
180
|
* <p>An offer dictates usage terms for the model.</p>
|
|
4
181
|
* @public
|
|
@@ -907,6 +1084,16 @@ export interface KnowledgeBaseVectorSearchConfiguration {
|
|
|
907
1084
|
* @public
|
|
908
1085
|
*/
|
|
909
1086
|
filter?: RetrievalFilter | undefined;
|
|
1087
|
+
/**
|
|
1088
|
+
* <p>Configuration for implicit filtering in Knowledge Base vector searches. This allows the system to automatically apply filters based on the query context without requiring explicit filter expressions.</p>
|
|
1089
|
+
* @public
|
|
1090
|
+
*/
|
|
1091
|
+
implicitFilterConfiguration?: ImplicitFilterConfiguration | undefined;
|
|
1092
|
+
/**
|
|
1093
|
+
* <p>Configuration for reranking search results in Knowledge Base vector searches. Reranking improves search relevance by reordering initial vector search results using more sophisticated relevance models.</p>
|
|
1094
|
+
* @public
|
|
1095
|
+
*/
|
|
1096
|
+
rerankingConfiguration?: VectorSearchRerankingConfiguration | undefined;
|
|
910
1097
|
}
|
|
911
1098
|
/**
|
|
912
1099
|
* <p>Contains configuration details for retrieving information from a knowledge base.</p>
|
|
@@ -39,8 +39,17 @@ export declare const getRuntimeConfig: (config: BedrockClientConfig) => {
|
|
|
39
39
|
tls?: boolean;
|
|
40
40
|
serviceConfiguredEndpoint?: never;
|
|
41
41
|
authSchemePreference?: string[] | import("@smithy/types").Provider<string[]>;
|
|
42
|
-
httpAuthSchemes:
|
|
42
|
+
httpAuthSchemes: ({
|
|
43
|
+
schemeId: string;
|
|
44
|
+
identityProvider: (ipc: import("@smithy/types").IdentityProviderConfig) => import("@smithy/types").IdentityProvider<import("@smithy/types").Identity> | undefined;
|
|
45
|
+
signer: import("@aws-sdk/core").AwsSdkSigV4Signer;
|
|
46
|
+
} | {
|
|
47
|
+
schemeId: string;
|
|
48
|
+
identityProvider: (ipc: import("@smithy/types").IdentityProviderConfig) => import("@smithy/types").IdentityProvider<import("@smithy/types").Identity> | undefined;
|
|
49
|
+
signer: import("@smithy/core").HttpBearerAuthSigner;
|
|
50
|
+
})[];
|
|
43
51
|
httpAuthSchemeProvider: import("./auth/httpAuthSchemeProvider").BedrockHttpAuthSchemeProvider;
|
|
52
|
+
token?: import("@smithy/types").TokenIdentity | import("@smithy/types").TokenIdentityProvider;
|
|
44
53
|
credentials?: import("@smithy/types").AwsCredentialIdentity | import("@smithy/types").AwsCredentialIdentityProvider;
|
|
45
54
|
signer?: import("@smithy/types").RequestSigner | ((authScheme?: import("@smithy/types").AuthScheme) => Promise<import("@smithy/types").RequestSigner>);
|
|
46
55
|
signingEscapePath?: boolean;
|
|
@@ -1,4 +1,7 @@
|
|
|
1
|
+
import { AwsSdkSigV4Signer } from "@aws-sdk/core";
|
|
2
|
+
import { HttpBearerAuthSigner } from "@smithy/core";
|
|
1
3
|
import { NodeHttpHandler as RequestHandler } from "@smithy/node-http-handler";
|
|
4
|
+
import { IdentityProviderConfig } from "@smithy/types";
|
|
2
5
|
import { BedrockClientConfig } from "./BedrockClient";
|
|
3
6
|
/**
|
|
4
7
|
* @internal
|
|
@@ -10,6 +13,15 @@ export declare const getRuntimeConfig: (config: BedrockClientConfig) => {
|
|
|
10
13
|
bodyLengthChecker: import("@smithy/types").BodyLengthCalculator;
|
|
11
14
|
credentialDefaultProvider: ((input: any) => import("@smithy/types").AwsCredentialIdentityProvider) | ((init?: import("@aws-sdk/credential-provider-node").DefaultProviderInit) => import("@smithy/types").MemoizedProvider<import("@smithy/types").AwsCredentialIdentity>);
|
|
12
15
|
defaultUserAgentProvider: (config?: import("@aws-sdk/util-user-agent-node").PreviouslyResolved) => Promise<import("@smithy/types").UserAgent>;
|
|
16
|
+
httpAuthSchemes: import("@smithy/types").HttpAuthScheme[] | ({
|
|
17
|
+
schemeId: string;
|
|
18
|
+
identityProvider: (ipc: IdentityProviderConfig) => import("@smithy/types").IdentityProvider<import("@smithy/types").Identity> | undefined;
|
|
19
|
+
signer: AwsSdkSigV4Signer;
|
|
20
|
+
} | {
|
|
21
|
+
schemeId: string;
|
|
22
|
+
identityProvider: (ipc: IdentityProviderConfig) => import("@smithy/types").IdentityProvider<import("@smithy/types").Identity>;
|
|
23
|
+
signer: HttpBearerAuthSigner;
|
|
24
|
+
})[];
|
|
13
25
|
maxAttempts: number | import("@smithy/types").Provider<number>;
|
|
14
26
|
region: string | import("@smithy/types").Provider<string>;
|
|
15
27
|
requestHandler: RequestHandler | import("@smithy/protocol-http").HttpHandler<any>;
|
|
@@ -39,8 +51,8 @@ export declare const getRuntimeConfig: (config: BedrockClientConfig) => {
|
|
|
39
51
|
}) => import("@smithy/types").EndpointV2;
|
|
40
52
|
tls?: boolean;
|
|
41
53
|
serviceConfiguredEndpoint?: never;
|
|
42
|
-
httpAuthSchemes: import("@smithy/types").HttpAuthScheme[];
|
|
43
54
|
httpAuthSchemeProvider: import("./auth/httpAuthSchemeProvider").BedrockHttpAuthSchemeProvider;
|
|
55
|
+
token?: import("@smithy/types").TokenIdentity | import("@smithy/types").TokenIdentityProvider;
|
|
44
56
|
credentials?: import("@smithy/types").AwsCredentialIdentity | import("@smithy/types").AwsCredentialIdentityProvider;
|
|
45
57
|
signer?: import("@smithy/types").RequestSigner | ((authScheme?: import("@smithy/types").AuthScheme) => Promise<import("@smithy/types").RequestSigner>);
|
|
46
58
|
signingEscapePath?: boolean;
|
|
@@ -38,8 +38,17 @@ export declare const getRuntimeConfig: (config: BedrockClientConfig) => {
|
|
|
38
38
|
tls?: boolean;
|
|
39
39
|
serviceConfiguredEndpoint?: never;
|
|
40
40
|
authSchemePreference?: string[] | import("@smithy/types").Provider<string[]>;
|
|
41
|
-
httpAuthSchemes:
|
|
41
|
+
httpAuthSchemes: ({
|
|
42
|
+
schemeId: string;
|
|
43
|
+
identityProvider: (ipc: import("@smithy/types").IdentityProviderConfig) => import("@smithy/types").IdentityProvider<import("@smithy/types").Identity> | undefined;
|
|
44
|
+
signer: import("@aws-sdk/core").AwsSdkSigV4Signer;
|
|
45
|
+
} | {
|
|
46
|
+
schemeId: string;
|
|
47
|
+
identityProvider: (ipc: import("@smithy/types").IdentityProviderConfig) => import("@smithy/types").IdentityProvider<import("@smithy/types").Identity> | undefined;
|
|
48
|
+
signer: import("@smithy/core").HttpBearerAuthSigner;
|
|
49
|
+
})[];
|
|
42
50
|
httpAuthSchemeProvider: import("./auth/httpAuthSchemeProvider").BedrockHttpAuthSchemeProvider;
|
|
51
|
+
token?: import("@smithy/types").TokenIdentity | import("@smithy/types").TokenIdentityProvider;
|
|
43
52
|
credentials?: import("@smithy/types").AwsCredentialIdentity | import("@smithy/types").AwsCredentialIdentityProvider;
|
|
44
53
|
signer?: import("@smithy/types").RequestSigner | ((authScheme?: import("@smithy/types").AuthScheme) => Promise<import("@smithy/types").RequestSigner>);
|
|
45
54
|
signingEscapePath?: boolean;
|