@aws-sdk/client-qbusiness 3.840.0 → 3.841.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 +40 -0
- package/dist-cjs/index.js +309 -27
- package/dist-es/QBusiness.js +10 -0
- package/dist-es/commands/CreateChatResponseConfigurationCommand.js +22 -0
- package/dist-es/commands/DeleteChatResponseConfigurationCommand.js +22 -0
- package/dist-es/commands/GetChatResponseConfigurationCommand.js +22 -0
- package/dist-es/commands/ListChatResponseConfigurationsCommand.js +22 -0
- package/dist-es/commands/UpdateChatResponseConfigurationCommand.js +22 -0
- package/dist-es/commands/index.js +5 -0
- package/dist-es/models/models_0.js +16 -19
- package/dist-es/models/models_1.js +20 -0
- package/dist-es/pagination/ListChatResponseConfigurationsPaginator.js +4 -0
- package/dist-es/pagination/index.js +1 -0
- package/dist-es/protocols/Aws_restJson1.js +166 -2
- package/dist-types/QBusiness.d.ts +35 -0
- package/dist-types/QBusinessClient.d.ts +7 -2
- package/dist-types/commands/CreateChatResponseConfigurationCommand.d.ts +116 -0
- package/dist-types/commands/CreateRetrieverCommand.d.ts +6 -5
- package/dist-types/commands/DeleteChatResponseConfigurationCommand.d.ts +89 -0
- package/dist-types/commands/GetChatResponseConfigurationCommand.d.ts +137 -0
- package/dist-types/commands/GetGroupCommand.d.ts +1 -1
- package/dist-types/commands/GetMediaCommand.d.ts +1 -1
- package/dist-types/commands/GetPolicyCommand.d.ts +1 -1
- package/dist-types/commands/GetRetrieverCommand.d.ts +6 -5
- package/dist-types/commands/GetUserCommand.d.ts +1 -2
- package/dist-types/commands/ListChatResponseConfigurationsCommand.d.ts +100 -0
- package/dist-types/commands/UpdateChatResponseConfigurationCommand.d.ts +105 -0
- package/dist-types/commands/UpdateRetrieverCommand.d.ts +6 -5
- package/dist-types/commands/index.d.ts +5 -0
- package/dist-types/models/models_0.d.ts +245 -177
- package/dist-types/models/models_1.d.ts +286 -1
- package/dist-types/pagination/ListChatResponseConfigurationsPaginator.d.ts +7 -0
- package/dist-types/pagination/index.d.ts +1 -0
- package/dist-types/protocols/Aws_restJson1.d.ts +45 -0
- package/dist-types/ts3.4/QBusiness.d.ts +85 -0
- package/dist-types/ts3.4/QBusinessClient.d.ts +30 -0
- package/dist-types/ts3.4/commands/CreateChatResponseConfigurationCommand.d.ts +51 -0
- package/dist-types/ts3.4/commands/DeleteChatResponseConfigurationCommand.d.ts +51 -0
- package/dist-types/ts3.4/commands/GetChatResponseConfigurationCommand.d.ts +51 -0
- package/dist-types/ts3.4/commands/GetGroupCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/GetMediaCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/GetPolicyCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/GetUserCommand.d.ts +1 -2
- package/dist-types/ts3.4/commands/ListChatResponseConfigurationsCommand.d.ts +51 -0
- package/dist-types/ts3.4/commands/UpdateChatResponseConfigurationCommand.d.ts +51 -0
- package/dist-types/ts3.4/commands/index.d.ts +5 -0
- package/dist-types/ts3.4/models/models_0.d.ts +71 -51
- package/dist-types/ts3.4/models/models_1.d.ts +88 -0
- package/dist-types/ts3.4/pagination/ListChatResponseConfigurationsPaginator.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 +60 -0
- package/package.json +1 -1
|
@@ -2600,7 +2600,7 @@ export interface CustomPluginConfiguration {
|
|
|
2600
2600
|
* <p>Contains either details about the S3 object containing the OpenAPI schema for the action group or the JSON or YAML-formatted payload defining the schema.</p>
|
|
2601
2601
|
* @public
|
|
2602
2602
|
*/
|
|
2603
|
-
apiSchema
|
|
2603
|
+
apiSchema?: APISchema | undefined;
|
|
2604
2604
|
}
|
|
2605
2605
|
/**
|
|
2606
2606
|
* @public
|
|
@@ -2942,6 +2942,8 @@ export declare const DocumentAttributeBoostingLevel: {
|
|
|
2942
2942
|
readonly LOW: "LOW";
|
|
2943
2943
|
readonly MEDIUM: "MEDIUM";
|
|
2944
2944
|
readonly NONE: "NONE";
|
|
2945
|
+
readonly ONE: "ONE";
|
|
2946
|
+
readonly TWO: "TWO";
|
|
2945
2947
|
readonly VERY_HIGH: "VERY_HIGH";
|
|
2946
2948
|
};
|
|
2947
2949
|
/**
|
|
@@ -2954,7 +2956,7 @@ export type DocumentAttributeBoostingLevel = (typeof DocumentAttributeBoostingLe
|
|
|
2954
2956
|
*/
|
|
2955
2957
|
export interface DateAttributeBoostingConfiguration {
|
|
2956
2958
|
/**
|
|
2957
|
-
* <p>Specifies
|
|
2959
|
+
* <p>Specifies the priority tier ranking of boosting applied to document attributes. For version 2, this parameter indicates the relative ranking between boosted fields (ONE being highest priority, TWO being second highest, etc.) and determines the order in which attributes influence document ranking in search results. For version 1, this parameter specifies the boosting intensity. For version 2, boosting intensity (VERY HIGH, HIGH, MEDIUM, LOW, NONE) are not supported. Note that in version 2, you are not allowed to boost on only one field and make this value TWO.</p>
|
|
2958
2960
|
* @public
|
|
2959
2961
|
*/
|
|
2960
2962
|
boostingLevel: DocumentAttributeBoostingLevel | undefined;
|
|
@@ -2977,17 +2979,17 @@ export declare const NumberAttributeBoostingType: {
|
|
|
2977
2979
|
*/
|
|
2978
2980
|
export type NumberAttributeBoostingType = (typeof NumberAttributeBoostingType)[keyof typeof NumberAttributeBoostingType];
|
|
2979
2981
|
/**
|
|
2980
|
-
* <p>Provides information on boosting <code>NUMBER</code> type document attributes.</p> <p>For more information on how boosting document attributes work in Amazon Q Business, see <a href="https://docs.aws.amazon.com/amazonq/latest/business-use-dg/metadata-boosting.html">Boosting using document attributes</a>.</p>
|
|
2982
|
+
* <p>Provides information on boosting <code>NUMBER</code> type document attributes.</p> <p>In the current boosting implementation, boosting focuses primarily on <code>DATE</code> attributes for recency and <code>STRING</code> attributes for source prioritization. <code>NUMBER</code> attributes can serve as additional boosting factors when needed, but are not supported when using <code>NativeIndexConfiguration</code> version 2.</p> <p>For more information on how boosting document attributes work in Amazon Q Business, see <a href="https://docs.aws.amazon.com/amazonq/latest/business-use-dg/metadata-boosting.html">Boosting using document attributes</a>.</p>
|
|
2981
2983
|
* @public
|
|
2982
2984
|
*/
|
|
2983
2985
|
export interface NumberAttributeBoostingConfiguration {
|
|
2984
2986
|
/**
|
|
2985
|
-
* <p>Specifies the
|
|
2987
|
+
* <p>Specifies the priority of boosted document attributes in relation to other boosted attributes. This parameter determines how strongly the attribute influences document ranking in search results. <code>NUMBER</code> attributes can serve as additional boosting factors when needed, but are not supported when using <code>NativeIndexConfiguration</code> version 2.</p>
|
|
2986
2988
|
* @public
|
|
2987
2989
|
*/
|
|
2988
2990
|
boostingLevel: DocumentAttributeBoostingLevel | undefined;
|
|
2989
2991
|
/**
|
|
2990
|
-
* <p>Specifies
|
|
2992
|
+
* <p>Specifies whether higher or lower numeric values should be prioritized when boosting. Valid values are ASCENDING (higher numbers are more important) and DESCENDING (lower numbers are more important).</p>
|
|
2991
2993
|
* @public
|
|
2992
2994
|
*/
|
|
2993
2995
|
boostingType?: NumberAttributeBoostingType | undefined;
|
|
@@ -2997,9 +2999,14 @@ export interface NumberAttributeBoostingConfiguration {
|
|
|
2997
2999
|
* @enum
|
|
2998
3000
|
*/
|
|
2999
3001
|
export declare const StringAttributeValueBoostingLevel: {
|
|
3002
|
+
readonly FIVE: "FIVE";
|
|
3003
|
+
readonly FOUR: "FOUR";
|
|
3000
3004
|
readonly HIGH: "HIGH";
|
|
3001
3005
|
readonly LOW: "LOW";
|
|
3002
3006
|
readonly MEDIUM: "MEDIUM";
|
|
3007
|
+
readonly ONE: "ONE";
|
|
3008
|
+
readonly THREE: "THREE";
|
|
3009
|
+
readonly TWO: "TWO";
|
|
3003
3010
|
readonly VERY_HIGH: "VERY_HIGH";
|
|
3004
3011
|
};
|
|
3005
3012
|
/**
|
|
@@ -3012,29 +3019,29 @@ export type StringAttributeValueBoostingLevel = (typeof StringAttributeValueBoos
|
|
|
3012
3019
|
*/
|
|
3013
3020
|
export interface StringAttributeBoostingConfiguration {
|
|
3014
3021
|
/**
|
|
3015
|
-
* <p>Specifies
|
|
3022
|
+
* <p>Specifies the priority tier ranking of boosting applied to document attributes. For version 2, this parameter indicates the relative ranking between boosted fields (ONE being highest priority, TWO being second highest, etc.) and determines the order in which attributes influence document ranking in search results. For version 1, this parameter specifies the boosting intensity. For version 2, boosting intensity (VERY HIGH, HIGH, MEDIUM, LOW, NONE) are not supported. Note that in version 2, you are not allowed to boost on only one field and make this value TWO.</p>
|
|
3016
3023
|
* @public
|
|
3017
3024
|
*/
|
|
3018
3025
|
boostingLevel: DocumentAttributeBoostingLevel | undefined;
|
|
3019
3026
|
/**
|
|
3020
|
-
* <p>Specifies specific values of a <code>STRING</code> type document attribute being boosted.</p>
|
|
3027
|
+
* <p>Specifies specific values of a <code>STRING</code> type document attribute being boosted. When using <code>NativeIndexConfiguration</code> version 2, you can specify up to five values in order of priority.</p>
|
|
3021
3028
|
* @public
|
|
3022
3029
|
*/
|
|
3023
3030
|
attributeValueBoosting?: Record<string, StringAttributeValueBoostingLevel> | undefined;
|
|
3024
3031
|
}
|
|
3025
3032
|
/**
|
|
3026
|
-
* <p>Provides information on boosting <code>STRING_LIST</code> type document attributes.</p> <note> <p>For <code>STRING</code> and <code>STRING_LIST</code> type document attributes to be used for boosting on the console and the API, they must be enabled for search using the <a href="https://docs.aws.amazon.com/amazonq/latest/api-reference/API_DocumentAttributeConfiguration.html">DocumentAttributeConfiguration</a> object of the <a href="https://docs.aws.amazon.com/amazonq/latest/api-reference/API_UpdateIndex.html">UpdateIndex</a> API. If you haven't enabled searching on these attributes, you can't boost attributes of these data types on either the console or the API.</p> </note> <p>For more information on how boosting document attributes work in Amazon Q Business, see <a href="https://docs.aws.amazon.com/amazonq/latest/business-use-dg/metadata-boosting.html">Boosting using document attributes</a>.</p>
|
|
3033
|
+
* <p>Provides information on boosting <code>STRING_LIST</code> type document attributes.</p> <p>In the current boosting implementation, boosting focuses primarily on <code>DATE</code> attributes for recency and <code>STRING</code> attributes for source prioritization. <code>STRING_LIST</code> attributes can serve as additional boosting factors when needed, but are not supported when using <code>NativeIndexConfiguration</code> version 2.</p> <note> <p>For <code>STRING</code> and <code>STRING_LIST</code> type document attributes to be used for boosting on the console and the API, they must be enabled for search using the <a href="https://docs.aws.amazon.com/amazonq/latest/api-reference/API_DocumentAttributeConfiguration.html">DocumentAttributeConfiguration</a> object of the <a href="https://docs.aws.amazon.com/amazonq/latest/api-reference/API_UpdateIndex.html">UpdateIndex</a> API. If you haven't enabled searching on these attributes, you can't boost attributes of these data types on either the console or the API.</p> </note> <p>For more information on how boosting document attributes work in Amazon Q Business, see <a href="https://docs.aws.amazon.com/amazonq/latest/business-use-dg/metadata-boosting.html">Boosting using document attributes</a>.</p>
|
|
3027
3034
|
* @public
|
|
3028
3035
|
*/
|
|
3029
3036
|
export interface StringListAttributeBoostingConfiguration {
|
|
3030
3037
|
/**
|
|
3031
|
-
* <p>Specifies
|
|
3038
|
+
* <p>Specifies the priority of boosted document attributes in relation to other boosted attributes. This parameter determines how strongly the attribute influences document ranking in search results. <code>STRING_LIST</code> attributes can serve as additional boosting factors when needed, but are not supported when using <code>NativeIndexConfiguration</code> version 2.</p>
|
|
3032
3039
|
* @public
|
|
3033
3040
|
*/
|
|
3034
3041
|
boostingLevel: DocumentAttributeBoostingLevel | undefined;
|
|
3035
3042
|
}
|
|
3036
3043
|
/**
|
|
3037
|
-
* <p>Provides information on boosting supported Amazon Q Business document attribute types. When an end user chat query matches document attributes that have been boosted, Amazon Q Business prioritizes generating responses from content that matches the boosted document attributes.</p> <note> <p>For <code>STRING</code> and <code>STRING_LIST</code> type document attributes to be used for boosting on the console and the API, they must be enabled for search using the <a href="https://docs.aws.amazon.com/amazonq/latest/api-reference/API_DocumentAttributeConfiguration.html">DocumentAttributeConfiguration</a> object of the <a href="https://docs.aws.amazon.com/amazonq/latest/api-reference/API_UpdateIndex.html">UpdateIndex</a> API. If you haven't enabled searching on these attributes, you can't boost attributes of these data types on either the console or the API.</p> </note> <p>For more information on how boosting document attributes work in Amazon Q Business, see <a href="https://docs.aws.amazon.com/amazonq/latest/business-use-dg/metadata-boosting.html">Boosting using document attributes</a>.</p>
|
|
3044
|
+
* <p>Provides information on boosting supported Amazon Q Business document attribute types. When an end user chat query matches document attributes that have been boosted, Amazon Q Business prioritizes generating responses from content that matches the boosted document attributes.</p> <p>In version 2, boosting uses numeric values (ONE, TWO) to indicate priority tiers that establish clear hierarchical relationships between boosted attributes. This allows for more precise control over how different attributes influence search results.</p> <note> <p>For <code>STRING</code> and <code>STRING_LIST</code> type document attributes to be used for boosting on the console and the API, they must be enabled for search using the <a href="https://docs.aws.amazon.com/amazonq/latest/api-reference/API_DocumentAttributeConfiguration.html">DocumentAttributeConfiguration</a> object of the <a href="https://docs.aws.amazon.com/amazonq/latest/api-reference/API_UpdateIndex.html">UpdateIndex</a> API. If you haven't enabled searching on these attributes, you can't boost attributes of these data types on either the console or the API.</p> </note> <p>For more information on how boosting document attributes work in Amazon Q Business, see <a href="https://docs.aws.amazon.com/amazonq/latest/business-use-dg/metadata-boosting.html">Boosting using document attributes</a>.</p>
|
|
3038
3045
|
* @public
|
|
3039
3046
|
*/
|
|
3040
3047
|
export type DocumentAttributeBoostingConfiguration = DocumentAttributeBoostingConfiguration.DateConfigurationMember | DocumentAttributeBoostingConfiguration.NumberConfigurationMember | DocumentAttributeBoostingConfiguration.StringConfigurationMember | DocumentAttributeBoostingConfiguration.StringListConfigurationMember | DocumentAttributeBoostingConfiguration.$UnknownMember;
|
|
@@ -3043,7 +3050,7 @@ export type DocumentAttributeBoostingConfiguration = DocumentAttributeBoostingCo
|
|
|
3043
3050
|
*/
|
|
3044
3051
|
export declare namespace DocumentAttributeBoostingConfiguration {
|
|
3045
3052
|
/**
|
|
3046
|
-
* <p>Provides information on boosting <code>NUMBER</code> type document attributes.</p>
|
|
3053
|
+
* <p>Provides information on boosting <code>NUMBER</code> type document attributes.</p> <p> <code>NUMBER</code> attributes are not supported when using <code>NativeIndexConfiguration</code> version 2, which focuses on <code>DATE</code> attributes for recency and <code>STRING</code> attributes for source prioritization.</p>
|
|
3047
3054
|
* @public
|
|
3048
3055
|
*/
|
|
3049
3056
|
interface NumberConfigurationMember {
|
|
@@ -3054,7 +3061,7 @@ export declare namespace DocumentAttributeBoostingConfiguration {
|
|
|
3054
3061
|
$unknown?: never;
|
|
3055
3062
|
}
|
|
3056
3063
|
/**
|
|
3057
|
-
* <p>Provides information on boosting <code>STRING</code> type document attributes.</p>
|
|
3064
|
+
* <p>Provides information on boosting <code>STRING</code> type document attributes.</p> <p>Version 2 assigns priority tiers to <code>STRING</code> attributes, establishing clear hierarchical relationships with other boosted attributes.</p>
|
|
3058
3065
|
* @public
|
|
3059
3066
|
*/
|
|
3060
3067
|
interface StringConfigurationMember {
|
|
@@ -3065,7 +3072,7 @@ export declare namespace DocumentAttributeBoostingConfiguration {
|
|
|
3065
3072
|
$unknown?: never;
|
|
3066
3073
|
}
|
|
3067
3074
|
/**
|
|
3068
|
-
* <p>Provides information on boosting <code>DATE</code> type document attributes.</p>
|
|
3075
|
+
* <p>Provides information on boosting <code>DATE</code> type document attributes.</p> <p>Version 2 assigns priority tiers to <code>DATE</code> attributes, establishing clear hierarchical relationships with other boosted attributes.</p>
|
|
3069
3076
|
* @public
|
|
3070
3077
|
*/
|
|
3071
3078
|
interface DateConfigurationMember {
|
|
@@ -3076,7 +3083,7 @@ export declare namespace DocumentAttributeBoostingConfiguration {
|
|
|
3076
3083
|
$unknown?: never;
|
|
3077
3084
|
}
|
|
3078
3085
|
/**
|
|
3079
|
-
* <p>Provides information on boosting <code>STRING_LIST</code> type document attributes.</p>
|
|
3086
|
+
* <p>Provides information on boosting <code>STRING_LIST</code> type document attributes.</p> <p> <code>STRING_LIST</code> attributes are not supported when using <code>NativeIndexConfiguration</code> version 2, which focuses on <code>DATE</code> attributes for recency and <code>STRING</code> attributes for source prioritization.</p>
|
|
3080
3087
|
* @public
|
|
3081
3088
|
*/
|
|
3082
3089
|
interface StringListConfigurationMember {
|
|
@@ -3115,6 +3122,11 @@ export interface NativeIndexConfiguration {
|
|
|
3115
3122
|
* @public
|
|
3116
3123
|
*/
|
|
3117
3124
|
indexId: string | undefined;
|
|
3125
|
+
/**
|
|
3126
|
+
* <p>A read-only field that specifies the version of the <code>NativeIndexConfiguration</code>.</p> <p>Amazon Q Business introduces enhanced document retrieval capabilities in version 2 of <code>NativeIndexConfiguration</code>, focusing on streamlined metadata boosting that prioritizes recency and source relevance to deliver more accurate responses to your queries. Version 2 has the following differences from version 1:</p> <ul> <li> <p>Version 2 supports a single Date field (created_at OR last_updated_at) for recency boosting</p> </li> <li> <p>Version 2 supports a single String field with an ordered list of up to 5 values</p> </li> <li> <p>Version 2 introduces number-based boost levels (ONE, TWO) alongside the text-based levels</p> </li> <li> <p>Version 2 allows specifying prioritization between Date and String fields</p> </li> <li> <p>Version 2 maintains backward compatibility with existing configurations</p> </li> </ul>
|
|
3127
|
+
* @public
|
|
3128
|
+
*/
|
|
3129
|
+
version?: number | undefined;
|
|
3118
3130
|
/**
|
|
3119
3131
|
* <p>Overrides the default boosts applied by Amazon Q Business to supported document attribute data types.</p>
|
|
3120
3132
|
* @public
|
|
@@ -5251,6 +5263,160 @@ export declare class LicenseNotFoundException extends __BaseException {
|
|
|
5251
5263
|
*/
|
|
5252
5264
|
constructor(opts: __ExceptionOptionType<LicenseNotFoundException, __BaseException>);
|
|
5253
5265
|
}
|
|
5266
|
+
/**
|
|
5267
|
+
* @public
|
|
5268
|
+
* @enum
|
|
5269
|
+
*/
|
|
5270
|
+
export declare const ChatResponseConfigurationStatus: {
|
|
5271
|
+
readonly ACTIVE: "ACTIVE";
|
|
5272
|
+
readonly CREATING: "CREATING";
|
|
5273
|
+
readonly FAILED: "FAILED";
|
|
5274
|
+
readonly UPDATING: "UPDATING";
|
|
5275
|
+
};
|
|
5276
|
+
/**
|
|
5277
|
+
* @public
|
|
5278
|
+
*/
|
|
5279
|
+
export type ChatResponseConfigurationStatus = (typeof ChatResponseConfigurationStatus)[keyof typeof ChatResponseConfigurationStatus];
|
|
5280
|
+
/**
|
|
5281
|
+
* <p>Configuration details that define how Amazon Q Business generates and formats responses to user queries in chat interactions. This configuration allows administrators to customize response characteristics to meet specific organizational needs and communication standards.</p>
|
|
5282
|
+
* @public
|
|
5283
|
+
*/
|
|
5284
|
+
export interface ChatResponseConfiguration {
|
|
5285
|
+
/**
|
|
5286
|
+
* <p>A unique identifier for your chat response configuration settings, used to reference and manage the configuration within the Amazon Q Business service.</p>
|
|
5287
|
+
* @public
|
|
5288
|
+
*/
|
|
5289
|
+
chatResponseConfigurationId: string | undefined;
|
|
5290
|
+
/**
|
|
5291
|
+
* <p>The Amazon Resource Name (ARN) of the chat response configuration, which uniquely identifies the resource across all Amazon Web Services services and accounts.</p>
|
|
5292
|
+
* @public
|
|
5293
|
+
*/
|
|
5294
|
+
chatResponseConfigurationArn: string | undefined;
|
|
5295
|
+
/**
|
|
5296
|
+
* <p>A human-readable name for the chat response configuration, making it easier to identify and manage multiple configurations within an organization.</p>
|
|
5297
|
+
* @public
|
|
5298
|
+
*/
|
|
5299
|
+
displayName: string | undefined;
|
|
5300
|
+
/**
|
|
5301
|
+
* <p>A summary of the response configuration settings, providing a concise overview of the key parameters that define how responses are generated and formatted.</p>
|
|
5302
|
+
* @public
|
|
5303
|
+
*/
|
|
5304
|
+
responseConfigurationSummary?: string | undefined;
|
|
5305
|
+
/**
|
|
5306
|
+
* <p>The current status of the chat response configuration, indicating whether it is active, pending, or in another state that affects its availability for use in chat interactions.</p>
|
|
5307
|
+
* @public
|
|
5308
|
+
*/
|
|
5309
|
+
status: ChatResponseConfigurationStatus | undefined;
|
|
5310
|
+
/**
|
|
5311
|
+
* <p>The timestamp indicating when the chat response configuration was initially created, useful for tracking the lifecycle of configuration resources.</p>
|
|
5312
|
+
* @public
|
|
5313
|
+
*/
|
|
5314
|
+
createdAt?: Date | undefined;
|
|
5315
|
+
/**
|
|
5316
|
+
* <p>The timestamp indicating when the chat response configuration was last modified, helping administrators track changes and maintain version awareness.</p>
|
|
5317
|
+
* @public
|
|
5318
|
+
*/
|
|
5319
|
+
updatedAt?: Date | undefined;
|
|
5320
|
+
}
|
|
5321
|
+
/**
|
|
5322
|
+
* @public
|
|
5323
|
+
* @enum
|
|
5324
|
+
*/
|
|
5325
|
+
export declare const ResponseConfigurationType: {
|
|
5326
|
+
readonly ALL: "ALL";
|
|
5327
|
+
};
|
|
5328
|
+
/**
|
|
5329
|
+
* @public
|
|
5330
|
+
*/
|
|
5331
|
+
export type ResponseConfigurationType = (typeof ResponseConfigurationType)[keyof typeof ResponseConfigurationType];
|
|
5332
|
+
/**
|
|
5333
|
+
* <p>A set of instructions that define how Amazon Q Business should generate and format responses to user queries. This collection includes parameters for controlling response characteristics such as length, audience targeting, perspective, style, identity, tone, and custom instructions.</p>
|
|
5334
|
+
* @public
|
|
5335
|
+
*/
|
|
5336
|
+
export interface InstructionCollection {
|
|
5337
|
+
/**
|
|
5338
|
+
* <p>Specifies the desired length of responses generated by Amazon Q Business. This parameter allows administrators to control whether responses are concise and brief or more detailed and comprehensive.</p>
|
|
5339
|
+
* @public
|
|
5340
|
+
*/
|
|
5341
|
+
responseLength?: string | undefined;
|
|
5342
|
+
/**
|
|
5343
|
+
* <p>Defines the intended audience for the responses, allowing Amazon Q Business to tailor its language, terminology, and explanations appropriately. This could range from technical experts to general users with varying levels of domain knowledge.</p>
|
|
5344
|
+
* @public
|
|
5345
|
+
*/
|
|
5346
|
+
targetAudience?: string | undefined;
|
|
5347
|
+
/**
|
|
5348
|
+
* <p>Determines the point of view or perspective from which Amazon Q Business generates responses, such as first-person, second-person, or third-person perspective, affecting how information is presented to users.</p>
|
|
5349
|
+
* @public
|
|
5350
|
+
*/
|
|
5351
|
+
perspective?: string | undefined;
|
|
5352
|
+
/**
|
|
5353
|
+
* <p>Specifies the formatting and structural style of responses, such as bullet points, paragraphs, step-by-step instructions, or other organizational formats that enhance readability and comprehension.</p>
|
|
5354
|
+
* @public
|
|
5355
|
+
*/
|
|
5356
|
+
outputStyle?: string | undefined;
|
|
5357
|
+
/**
|
|
5358
|
+
* <p>Defines the persona or identity that Amazon Q Business should adopt when responding to users, allowing for customization of the assistant's character, role, or representation within an organization.</p>
|
|
5359
|
+
* @public
|
|
5360
|
+
*/
|
|
5361
|
+
identity?: string | undefined;
|
|
5362
|
+
/**
|
|
5363
|
+
* <p>Controls the emotional tone and communication style of responses, such as formal, casual, technical, friendly, or professional, to align with organizational communication standards and user expectations.</p>
|
|
5364
|
+
* @public
|
|
5365
|
+
*/
|
|
5366
|
+
tone?: string | undefined;
|
|
5367
|
+
/**
|
|
5368
|
+
* <p>Allows administrators to provide specific, custom instructions that guide how Amazon Q Business should respond in particular scenarios or to certain types of queries, enabling fine-grained control over response generation.</p>
|
|
5369
|
+
* @public
|
|
5370
|
+
*/
|
|
5371
|
+
customInstructions?: string | undefined;
|
|
5372
|
+
/**
|
|
5373
|
+
* <p>Provides sample responses or templates that Amazon Q Business can reference when generating responses, helping to establish consistent patterns and formats for different types of user queries.</p>
|
|
5374
|
+
* @public
|
|
5375
|
+
*/
|
|
5376
|
+
examples?: string | undefined;
|
|
5377
|
+
}
|
|
5378
|
+
/**
|
|
5379
|
+
* <p>Configuration settings to define how Amazon Q Business generates and formats responses to user queries. This includes customization options for response style, tone, length, and other characteristics.</p>
|
|
5380
|
+
* @public
|
|
5381
|
+
*/
|
|
5382
|
+
export interface ResponseConfiguration {
|
|
5383
|
+
/**
|
|
5384
|
+
* <p>A collection of instructions that guide how Amazon Q Business generates responses, including parameters for response length, target audience, perspective, output style, identity, tone, and custom instructions.</p>
|
|
5385
|
+
* @public
|
|
5386
|
+
*/
|
|
5387
|
+
instructionCollection?: InstructionCollection | undefined;
|
|
5388
|
+
}
|
|
5389
|
+
/**
|
|
5390
|
+
* <p>Detailed information about a chat response configuration, including comprehensive settings and parameters that define how Amazon Q Business generates and formats responses.</p>
|
|
5391
|
+
* @public
|
|
5392
|
+
*/
|
|
5393
|
+
export interface ChatResponseConfigurationDetail {
|
|
5394
|
+
/**
|
|
5395
|
+
* <p>A collection of specific response configuration settings that collectively define how responses are generated, formatted, and presented to users in chat interactions.</p>
|
|
5396
|
+
* @public
|
|
5397
|
+
*/
|
|
5398
|
+
responseConfigurations?: Partial<Record<ResponseConfigurationType, ResponseConfiguration>> | undefined;
|
|
5399
|
+
/**
|
|
5400
|
+
* <p>A summary of the response configuration details, providing a concise overview of the key parameters and settings that define the response generation behavior.</p>
|
|
5401
|
+
* @public
|
|
5402
|
+
*/
|
|
5403
|
+
responseConfigurationSummary?: string | undefined;
|
|
5404
|
+
/**
|
|
5405
|
+
* <p>The current status of the chat response configuration, indicating whether it is active, pending, or in another state that affects its availability for use.</p>
|
|
5406
|
+
* @public
|
|
5407
|
+
*/
|
|
5408
|
+
status?: ChatResponseConfigurationStatus | undefined;
|
|
5409
|
+
/**
|
|
5410
|
+
* <p>Provides information about a Amazon Q Business request error.</p>
|
|
5411
|
+
* @public
|
|
5412
|
+
*/
|
|
5413
|
+
error?: ErrorDetail | undefined;
|
|
5414
|
+
/**
|
|
5415
|
+
* <p>The timestamp indicating when the detailed chat response configuration was last modified, helping administrators track changes and maintain version awareness.</p>
|
|
5416
|
+
* @public
|
|
5417
|
+
*/
|
|
5418
|
+
updatedAt?: Date | undefined;
|
|
5419
|
+
}
|
|
5254
5420
|
/**
|
|
5255
5421
|
* @public
|
|
5256
5422
|
*/
|
|
@@ -5566,6 +5732,51 @@ export interface CreateAnonymousWebExperienceUrlResponse {
|
|
|
5566
5732
|
*/
|
|
5567
5733
|
anonymousUrl?: string | undefined;
|
|
5568
5734
|
}
|
|
5735
|
+
/**
|
|
5736
|
+
* @public
|
|
5737
|
+
*/
|
|
5738
|
+
export interface CreateChatResponseConfigurationRequest {
|
|
5739
|
+
/**
|
|
5740
|
+
* <p>The unique identifier of the Amazon Q Business application for which to create the new chat response configuration.</p>
|
|
5741
|
+
* @public
|
|
5742
|
+
*/
|
|
5743
|
+
applicationId: string | undefined;
|
|
5744
|
+
/**
|
|
5745
|
+
* <p>A human-readable name for the new chat response configuration, making it easier to identify and manage among multiple configurations.</p>
|
|
5746
|
+
* @public
|
|
5747
|
+
*/
|
|
5748
|
+
displayName: string | undefined;
|
|
5749
|
+
/**
|
|
5750
|
+
* <p>A unique, case-sensitive identifier to ensure idempotency of the request. This helps prevent the same configuration from being created multiple times if retries occur.</p>
|
|
5751
|
+
* @public
|
|
5752
|
+
*/
|
|
5753
|
+
clientToken?: string | undefined;
|
|
5754
|
+
/**
|
|
5755
|
+
* <p>A collection of response configuration settings that define how Amazon Q Business will generate and format responses to user queries in chat interactions.</p>
|
|
5756
|
+
* @public
|
|
5757
|
+
*/
|
|
5758
|
+
responseConfigurations: Partial<Record<ResponseConfigurationType, ResponseConfiguration>> | undefined;
|
|
5759
|
+
/**
|
|
5760
|
+
* <p>A list of key-value pairs to apply as tags to the new chat response configuration, enabling categorization and management of resources across Amazon Web Services services.</p>
|
|
5761
|
+
* @public
|
|
5762
|
+
*/
|
|
5763
|
+
tags?: Tag[] | undefined;
|
|
5764
|
+
}
|
|
5765
|
+
/**
|
|
5766
|
+
* @public
|
|
5767
|
+
*/
|
|
5768
|
+
export interface CreateChatResponseConfigurationResponse {
|
|
5769
|
+
/**
|
|
5770
|
+
* <p>The unique identifier assigned to a newly created chat response configuration, used for subsequent operations on this resource.</p>
|
|
5771
|
+
* @public
|
|
5772
|
+
*/
|
|
5773
|
+
chatResponseConfigurationId: string | undefined;
|
|
5774
|
+
/**
|
|
5775
|
+
* <p>The Amazon Resource Name (ARN) of the newly created chat response configuration, which uniquely identifies the resource across all Amazon Web Services services. </p>
|
|
5776
|
+
* @public
|
|
5777
|
+
*/
|
|
5778
|
+
chatResponseConfigurationArn: string | undefined;
|
|
5779
|
+
}
|
|
5569
5780
|
/**
|
|
5570
5781
|
* <p>A user or group in the IAM Identity Center instance connected to the Amazon Q Business application.</p>
|
|
5571
5782
|
* @public
|
|
@@ -5854,6 +6065,26 @@ export interface DeleteChatControlsConfigurationRequest {
|
|
|
5854
6065
|
*/
|
|
5855
6066
|
export interface DeleteChatControlsConfigurationResponse {
|
|
5856
6067
|
}
|
|
6068
|
+
/**
|
|
6069
|
+
* @public
|
|
6070
|
+
*/
|
|
6071
|
+
export interface DeleteChatResponseConfigurationRequest {
|
|
6072
|
+
/**
|
|
6073
|
+
* <p>The unique identifier of theAmazon Q Business application from which to delete the chat response configuration.</p>
|
|
6074
|
+
* @public
|
|
6075
|
+
*/
|
|
6076
|
+
applicationId: string | undefined;
|
|
6077
|
+
/**
|
|
6078
|
+
* <p>The unique identifier of the chat response configuration to delete from the specified application. </p>
|
|
6079
|
+
* @public
|
|
6080
|
+
*/
|
|
6081
|
+
chatResponseConfigurationId: string | undefined;
|
|
6082
|
+
}
|
|
6083
|
+
/**
|
|
6084
|
+
* @public
|
|
6085
|
+
*/
|
|
6086
|
+
export interface DeleteChatResponseConfigurationResponse {
|
|
6087
|
+
}
|
|
5857
6088
|
/**
|
|
5858
6089
|
* @public
|
|
5859
6090
|
*/
|
|
@@ -6215,169 +6446,6 @@ export interface GetChatControlsConfigurationResponse {
|
|
|
6215
6446
|
*/
|
|
6216
6447
|
hallucinationReductionConfiguration?: HallucinationReductionConfiguration | undefined;
|
|
6217
6448
|
}
|
|
6218
|
-
/**
|
|
6219
|
-
* @public
|
|
6220
|
-
*/
|
|
6221
|
-
export interface GetGroupRequest {
|
|
6222
|
-
/**
|
|
6223
|
-
* <p>The identifier of the application id the group is attached to.</p>
|
|
6224
|
-
* @public
|
|
6225
|
-
*/
|
|
6226
|
-
applicationId: string | undefined;
|
|
6227
|
-
/**
|
|
6228
|
-
* <p>The identifier of the index the group is attached to.</p>
|
|
6229
|
-
* @public
|
|
6230
|
-
*/
|
|
6231
|
-
indexId: string | undefined;
|
|
6232
|
-
/**
|
|
6233
|
-
* <p>The name of the group.</p>
|
|
6234
|
-
* @public
|
|
6235
|
-
*/
|
|
6236
|
-
groupName: string | undefined;
|
|
6237
|
-
/**
|
|
6238
|
-
* <p>The identifier of the data source the group is attached to.</p>
|
|
6239
|
-
* @public
|
|
6240
|
-
*/
|
|
6241
|
-
dataSourceId?: string | undefined;
|
|
6242
|
-
}
|
|
6243
|
-
/**
|
|
6244
|
-
* @public
|
|
6245
|
-
* @enum
|
|
6246
|
-
*/
|
|
6247
|
-
export declare const GroupStatus: {
|
|
6248
|
-
readonly DELETED: "DELETED";
|
|
6249
|
-
readonly DELETING: "DELETING";
|
|
6250
|
-
readonly FAILED: "FAILED";
|
|
6251
|
-
readonly PROCESSING: "PROCESSING";
|
|
6252
|
-
readonly SUCCEEDED: "SUCCEEDED";
|
|
6253
|
-
};
|
|
6254
|
-
/**
|
|
6255
|
-
* @public
|
|
6256
|
-
*/
|
|
6257
|
-
export type GroupStatus = (typeof GroupStatus)[keyof typeof GroupStatus];
|
|
6258
|
-
/**
|
|
6259
|
-
* <p>Provides the details of a group's status.</p>
|
|
6260
|
-
* @public
|
|
6261
|
-
*/
|
|
6262
|
-
export interface GroupStatusDetail {
|
|
6263
|
-
/**
|
|
6264
|
-
* <p>The status of a group.</p>
|
|
6265
|
-
* @public
|
|
6266
|
-
*/
|
|
6267
|
-
status?: GroupStatus | undefined;
|
|
6268
|
-
/**
|
|
6269
|
-
* <p>The Unix timestamp when the Amazon Q Business application was last updated.</p>
|
|
6270
|
-
* @public
|
|
6271
|
-
*/
|
|
6272
|
-
lastUpdatedAt?: Date | undefined;
|
|
6273
|
-
/**
|
|
6274
|
-
* <p>The details of an error associated a group status.</p>
|
|
6275
|
-
* @public
|
|
6276
|
-
*/
|
|
6277
|
-
errorDetail?: ErrorDetail | undefined;
|
|
6278
|
-
}
|
|
6279
|
-
/**
|
|
6280
|
-
* @public
|
|
6281
|
-
*/
|
|
6282
|
-
export interface GetGroupResponse {
|
|
6283
|
-
/**
|
|
6284
|
-
* <p>The current status of the group.</p>
|
|
6285
|
-
* @public
|
|
6286
|
-
*/
|
|
6287
|
-
status?: GroupStatusDetail | undefined;
|
|
6288
|
-
/**
|
|
6289
|
-
* <p>The status history of the group.</p>
|
|
6290
|
-
* @public
|
|
6291
|
-
*/
|
|
6292
|
-
statusHistory?: GroupStatusDetail[] | undefined;
|
|
6293
|
-
}
|
|
6294
|
-
/**
|
|
6295
|
-
* @public
|
|
6296
|
-
*/
|
|
6297
|
-
export interface GetMediaRequest {
|
|
6298
|
-
/**
|
|
6299
|
-
* <p>The identifier of the Amazon Q Business which contains the media object.</p>
|
|
6300
|
-
* @public
|
|
6301
|
-
*/
|
|
6302
|
-
applicationId: string | undefined;
|
|
6303
|
-
/**
|
|
6304
|
-
* <p>The identifier of the Amazon Q Business conversation.</p>
|
|
6305
|
-
* @public
|
|
6306
|
-
*/
|
|
6307
|
-
conversationId: string | undefined;
|
|
6308
|
-
/**
|
|
6309
|
-
* <p>The identifier of the Amazon Q Business message.</p>
|
|
6310
|
-
* @public
|
|
6311
|
-
*/
|
|
6312
|
-
messageId: string | undefined;
|
|
6313
|
-
/**
|
|
6314
|
-
* <p>The identifier of the media object. You can find this in the <code>sourceAttributions</code> returned by the <code>Chat</code>, <code>ChatSync</code>, and <code>ListMessages</code> API responses.</p>
|
|
6315
|
-
* @public
|
|
6316
|
-
*/
|
|
6317
|
-
mediaId: string | undefined;
|
|
6318
|
-
}
|
|
6319
|
-
/**
|
|
6320
|
-
* @public
|
|
6321
|
-
*/
|
|
6322
|
-
export interface GetMediaResponse {
|
|
6323
|
-
/**
|
|
6324
|
-
* <p>The base64-encoded bytes of the media object.</p>
|
|
6325
|
-
* @public
|
|
6326
|
-
*/
|
|
6327
|
-
mediaBytes?: Uint8Array | undefined;
|
|
6328
|
-
/**
|
|
6329
|
-
* <p>The MIME type of the media object (image/png).</p>
|
|
6330
|
-
* @public
|
|
6331
|
-
*/
|
|
6332
|
-
mediaMimeType?: string | undefined;
|
|
6333
|
-
}
|
|
6334
|
-
/**
|
|
6335
|
-
* <p>The requested media object is too large to be returned.</p>
|
|
6336
|
-
* @public
|
|
6337
|
-
*/
|
|
6338
|
-
export declare class MediaTooLargeException extends __BaseException {
|
|
6339
|
-
readonly name: "MediaTooLargeException";
|
|
6340
|
-
readonly $fault: "client";
|
|
6341
|
-
/**
|
|
6342
|
-
* @internal
|
|
6343
|
-
*/
|
|
6344
|
-
constructor(opts: __ExceptionOptionType<MediaTooLargeException, __BaseException>);
|
|
6345
|
-
}
|
|
6346
|
-
/**
|
|
6347
|
-
* @public
|
|
6348
|
-
*/
|
|
6349
|
-
export interface GetPolicyRequest {
|
|
6350
|
-
/**
|
|
6351
|
-
* <p>The unique identifier of the Amazon Q Business application.</p>
|
|
6352
|
-
* @public
|
|
6353
|
-
*/
|
|
6354
|
-
applicationId: string | undefined;
|
|
6355
|
-
}
|
|
6356
|
-
/**
|
|
6357
|
-
* @public
|
|
6358
|
-
*/
|
|
6359
|
-
export interface GetPolicyResponse {
|
|
6360
|
-
/**
|
|
6361
|
-
* <p>The JSON representation of the permission policy.</p>
|
|
6362
|
-
* @public
|
|
6363
|
-
*/
|
|
6364
|
-
policy?: string | undefined;
|
|
6365
|
-
}
|
|
6366
|
-
/**
|
|
6367
|
-
* @public
|
|
6368
|
-
*/
|
|
6369
|
-
export interface GetUserRequest {
|
|
6370
|
-
/**
|
|
6371
|
-
* <p>The identifier of the application connected to the user.</p>
|
|
6372
|
-
* @public
|
|
6373
|
-
*/
|
|
6374
|
-
applicationId: string | undefined;
|
|
6375
|
-
/**
|
|
6376
|
-
* <p>The user email address attached to the user.</p>
|
|
6377
|
-
* @public
|
|
6378
|
-
*/
|
|
6379
|
-
userId: string | undefined;
|
|
6380
|
-
}
|
|
6381
6449
|
/**
|
|
6382
6450
|
* @internal
|
|
6383
6451
|
*/
|