@aws-sdk/client-lex-models-v2 3.1005.0 → 3.1007.0

package/dist-types/models/enums.d.ts

@@ -56,6 +56,17 @@ export declare const SortOrder: {
  * @public
  */
 export type SortOrder = (typeof SortOrder)[keyof typeof SortOrder];
+/**
+ * @public
+ * @enum
+ */
+export declare const AnalysisScope: {
+    readonly BotLocale: "BotLocale";
+};
+/**
+ * @public
+ */
+export type AnalysisScope = (typeof AnalysisScope)[keyof typeof AnalysisScope];
 /**
  * @public
  * @enum
@@ -460,6 +471,34 @@ export declare const BotAliasStatus: {
  * @public
  */
 export type BotAliasStatus = (typeof BotAliasStatus)[keyof typeof BotAliasStatus];
+/**
+ * @public
+ * @enum
+ */
+export declare const BotAnalyzerStatus: {
+    readonly Available: "Available";
+    readonly Failed: "Failed";
+    readonly Processing: "Processing";
+    readonly Stopped: "Stopped";
+    readonly Stopping: "Stopping";
+};
+/**
+ * @public
+ */
+export type BotAnalyzerStatus = (typeof BotAnalyzerStatus)[keyof typeof BotAnalyzerStatus];
+/**
+ * @public
+ * @enum
+ */
+export declare const Priority: {
+    readonly High: "High";
+    readonly Low: "Low";
+    readonly Medium: "Medium";
+};
+/**
+ * @public
+ */
+export type Priority = (typeof Priority)[keyof typeof Priority];
 /**
  * @public
  * @enum

package/dist-types/models/models_0.d.ts

@@ -1,4 +1,4 @@
-import { AggregatedUtterancesFilterName, AggregatedUtterancesFilterOperator, AggregatedUtterancesSortAttribute, AnalyticsBinByName, AnalyticsCommonFilterName, AnalyticsFilterOperator, AnalyticsIntentField, AnalyticsIntentFilterName, AnalyticsIntentMetricName, AnalyticsIntentStageField, AnalyticsIntentStageFilterName, AnalyticsIntentStageMetricName, AnalyticsInterval, AnalyticsMetricStatistic, AnalyticsNodeType, AnalyticsSessionField, AnalyticsSessionFilterName, AnalyticsSessionMetricName, AnalyticsSortOrder, AnalyticsUtteranceAttributeName, AnalyticsUtteranceField, AnalyticsUtteranceFilterName, AnalyticsUtteranceMetricName, AssistedNluMode, AssociatedTranscriptFilterName, AudioRecognitionStrategy, BedrockTraceStatus, BotAliasReplicationStatus, BotAliasStatus, BotFilterName, BotFilterOperator, BotLocaleFilterName, BotLocaleFilterOperator, BotLocaleSortAttribute, BotLocaleStatus, BotRecommendationStatus, BotReplicaStatus, BotSortAttribute, BotStatus, BotType, BotVersionReplicaSortAttribute, BotVersionReplicationStatus, BotVersionSortAttribute, BuiltInIntentSortAttribute, BuiltInSlotTypeSortAttribute, ConversationLogsInputModeFilter, CustomVocabularyStatus, DialogActionType, Effect, ErrorCode, ExportFilterName, ExportFilterOperator, ExportSortAttribute, ExportStatus, GenerationSortByAttribute, GenerationStatus, ImportExportFileFormat, ImportFilterName, ImportFilterOperator, ImportResourceType, ImportSortAttribute, ImportStatus, IntentFilterName, IntentFilterOperator, MergeStrategy, MessageSelectionStrategy, ObfuscationSettingType, PromptAttempt, SlotResolutionStrategy, SlotValueResolutionStrategy, SortOrder, SpeechDetectionSensitivity, SpeechModelPreference, TestExecutionApiMode, TestExecutionModality, TestExecutionStatus, TestResultMatchStatus, TestSetDiscrepancyReportStatus, TestSetGenerationStatus, TestSetModality, TestSetStatus, TranscriptFormat, VoiceEngine } from "./enums";
+import { AggregatedUtterancesFilterName, AggregatedUtterancesFilterOperator, AggregatedUtterancesSortAttribute, AnalyticsBinByName, AnalyticsCommonFilterName, AnalyticsFilterOperator, AnalyticsIntentField, AnalyticsIntentFilterName, AnalyticsIntentMetricName, AnalyticsIntentStageField, AnalyticsIntentStageFilterName, AnalyticsIntentStageMetricName, AnalyticsInterval, AnalyticsMetricStatistic, AnalyticsNodeType, AnalyticsSessionField, AnalyticsSessionFilterName, AnalyticsSessionMetricName, AnalyticsSortOrder, AnalyticsUtteranceAttributeName, AnalyticsUtteranceField, AnalyticsUtteranceFilterName, AnalyticsUtteranceMetricName, AssistedNluMode, AssociatedTranscriptFilterName, AudioRecognitionStrategy, BedrockTraceStatus, BotAliasReplicationStatus, BotAliasStatus, BotAnalyzerStatus, BotFilterName, BotFilterOperator, BotLocaleFilterName, BotLocaleFilterOperator, BotLocaleSortAttribute, BotLocaleStatus, BotRecommendationStatus, BotReplicaStatus, BotSortAttribute, BotStatus, BotType, BotVersionReplicaSortAttribute, BotVersionReplicationStatus, BotVersionSortAttribute, BuiltInIntentSortAttribute, BuiltInSlotTypeSortAttribute, ConversationLogsInputModeFilter, CustomVocabularyStatus, DialogActionType, Effect, ErrorCode, ExportFilterName, ExportFilterOperator, ExportSortAttribute, ExportStatus, GenerationSortByAttribute, GenerationStatus, ImportExportFileFormat, ImportFilterName, ImportFilterOperator, ImportSortAttribute, ImportStatus, MergeStrategy, MessageSelectionStrategy, ObfuscationSettingType, Priority, PromptAttempt, SlotResolutionStrategy, SlotValueResolutionStrategy, SortOrder, SpeechDetectionSensitivity, SpeechModelPreference, TestExecutionApiMode, TestExecutionModality, TestExecutionStatus, TestResultMatchStatus, TestSetDiscrepancyReportStatus, TestSetGenerationStatus, TestSetModality, TestSetStatus, TranscriptFormat, VoiceEngine } from "./enums";
 /**
  * <p>The active context used in the test execution.</p>
  * @public
@@ -2435,6 +2435,78 @@ export interface BotAliasTestExecutionTarget {
      */
     localeId: string | undefined;
 }
+/**
+ * <p>Contains summary information about a historical bot analysis execution.</p>
+ * @public
+ */
+export interface BotAnalyzerHistorySummary {
+    /**
+     * <p>The status of the historical analysis execution.</p>
+     *          <p>Valid Values: <code>Processing | Available | Failed | Stopping | Stopped</code>
+     *          </p>
+     * @public
+     */
+    botAnalyzerStatus: BotAnalyzerStatus | undefined;
+    /**
+     * <p>The date and time when the analysis was initiated.</p>
+     * @public
+     */
+    creationDateTime?: Date | undefined;
+    /**
+     * <p>The unique identifier for the analysis request.</p>
+     * @public
+     */
+    botAnalyzerRequestId: string | undefined;
+}
+/**
+ * <p>Specifies the location of an identified issue within the bot configuration.</p>
+ * @public
+ */
+export interface IssueLocation {
+    /**
+     * <p>The locale identifier where the issue was found.</p>
+     * @public
+     */
+    botLocale?: string | undefined;
+    /**
+     * <p>The intent identifier where the issue was found, if applicable.</p>
+     * @public
+     */
+    intentId?: string | undefined;
+    /**
+     * <p>The slot identifier where the issue was found, if applicable.</p>
+     * @public
+     */
+    slotId?: string | undefined;
+}
+/**
+ * <p>Contains a recommendation for bot optimization identified by the Bot Analyzer.</p>
+ * @public
+ */
+export interface BotAnalyzerRecommendation {
+    /**
+     * <p>The location information for the identified issue within the bot configuration.</p>
+     * @public
+     */
+    issueLocation: IssueLocation | undefined;
+    /**
+     * <p>The priority level of the recommendation.</p>
+     *          <p>Valid Values: <code>High | Medium | Low</code>
+     *          </p>
+     * @public
+     */
+    priority: Priority | undefined;
+    /**
+     * <p>A detailed description of the identified configuration issue.</p>
+     * @public
+     */
+    issueDescription: string | undefined;
+    /**
+     * <p>The recommended solution to address the identified issue.</p>
+     * @public
+     */
+    proposedFix: string | undefined;
+}
 /**
  * <p>Provides the identity of a the bot that was exported.</p>
  * @public
@@ -5928,6 +6000,26 @@ export interface DeleteBotAliasResponse {
      */
     botAliasStatus?: BotAliasStatus | undefined;
 }
+/**
+ * @public
+ */
+export interface DeleteBotAnalyzerRecommendationRequest {
+    /**
+     * <p>The unique identifier of the bot.</p>
+     * @public
+     */
+    botId: string | undefined;
+    /**
+     * <p>The unique identifier of the analysis request whose recommendations should be deleted.</p>
+     * @public
+     */
+    botAnalyzerRequestId: string | undefined;
+}
+/**
+ * @public
+ */
+export interface DeleteBotAnalyzerRecommendationResponse {
+}
 /**
  * @public
  */
@@ -6575,6 +6667,73 @@ export interface DescribeBotAliasResponse {
      */
     parentBotNetworks?: ParentBotNetwork[] | undefined;
 }
+/**
+ * @public
+ */
+export interface DescribeBotAnalyzerRecommendationRequest {
+    /**
+     * <p>The unique identifier of the bot.</p>
+     * @public
+     */
+    botId: string | undefined;
+    /**
+     * <p>The unique identifier of the analysis request.</p>
+     * @public
+     */
+    botAnalyzerRequestId: string | undefined;
+    /**
+     * <p>If the response from a previous request was truncated, the <code>nextToken</code> value is used to retrieve the next page of recommendations.</p>
+     * @public
+     */
+    nextToken?: string | undefined;
+    /**
+     * <p>The maximum number of recommendations to return in the response. The default is 5.</p>
+     * @public
+     */
+    maxResults?: number | undefined;
+}
+/**
+ * @public
+ */
+export interface DescribeBotAnalyzerRecommendationResponse {
+    /**
+     * <p>The unique identifier of the bot.</p>
+     * @public
+     */
+    botId?: string | undefined;
+    /**
+     * <p>The version of the bot that was analyzed.</p>
+     * @public
+     */
+    botVersion?: string | undefined;
+    /**
+     * <p>The locale identifier of the bot locale that was analyzed.</p>
+     * @public
+     */
+    localeId?: string | undefined;
+    /**
+     * <p>The current status of the analysis.</p>
+     *          <p>Valid Values: <code>Processing | Available | Failed | Stopping | Stopped</code>
+     *          </p>
+     * @public
+     */
+    botAnalyzerStatus?: BotAnalyzerStatus | undefined;
+    /**
+     * <p>The date and time when the analysis was initiated.</p>
+     * @public
+     */
+    creationDateTime?: Date | undefined;
+    /**
+     * <p>A list of recommendations for optimizing your bot configuration. Each recommendation includes the issue location, priority, description, and proposed fix.</p>
+     * @public
+     */
+    botAnalyzerRecommendationList?: BotAnalyzerRecommendation[] | undefined;
+    /**
+     * <p>If the response is truncated, this token can be used in a subsequent request to retrieve the next page of recommendations.</p>
+     * @public
+     */
+    nextToken?: string | undefined;
+}
 /**
  * @public
  */
@@ -8269,166 +8428,3 @@ export interface ImportSortBy {
      */
     order: SortOrder | undefined;
 }
-/**
- * <p>Provides summary information about an import in an import
- *          list.</p>
- * @public
- */
-export interface ImportSummary {
-    /**
-     * <p>The unique identifier that Amazon Lex assigned to the import.</p>
-     * @public
-     */
-    importId?: string | undefined;
-    /**
-     * <p>The unique identifier that Amazon Lex assigned to the imported
-     *          resource.</p>
-     * @public
-     */
-    importedResourceId?: string | undefined;
-    /**
-     * <p>The name that you gave the imported resource.</p>
-     * @public
-     */
-    importedResourceName?: string | undefined;
-    /**
-     * <p>The status of the resource. When the status is
-     *          <code>Completed</code> the resource is ready to build.</p>
-     * @public
-     */
-    importStatus?: ImportStatus | undefined;
-    /**
-     * <p>The strategy used to merge existing bot or bot locale definitions
-     *          with the imported definition.</p>
-     * @public
-     */
-    mergeStrategy?: MergeStrategy | undefined;
-    /**
-     * <p>The date and time that the import was created.</p>
-     * @public
-     */
-    creationDateTime?: Date | undefined;
-    /**
-     * <p>The date and time that the import was last updated.</p>
-     * @public
-     */
-    lastUpdatedDateTime?: Date | undefined;
-    /**
-     * <p>The type of resource that was imported.</p>
-     * @public
-     */
-    importedResourceType?: ImportResourceType | undefined;
-}
-/**
- * <p>Provides the phrase that Amazon Lex should look for in the user's input
- *  to the bot.</p>
- * @public
- */
-export interface RuntimeHintValue {
-    /**
-     * <p>The phrase that Amazon Lex should look for in the user's input to the
-     *  bot.</p>
-     * @public
-     */
-    phrase: string | undefined;
-}
-/**
- * <p>The number of items in the intent classification test.</p>
- * @public
- */
-export interface IntentClassificationTestResultItemCounts {
-    /**
-     * <p>The total number of results in the intent classification test.</p>
-     * @public
-     */
-    totalResultCount: number | undefined;
-    /**
-     * <p>The number of matched, mismatched, and execution error results for speech transcription for the intent.</p>
-     * @public
-     */
-    speechTranscriptionResultCounts?: Partial<Record<TestResultMatchStatus, number>> | undefined;
-    /**
-     * <p>The number of matched and mismatched results for intent recognition for the intent.</p>
-     * @public
-     */
-    intentMatchResultCounts: Partial<Record<TestResultMatchStatus, number>> | undefined;
-}
-/**
- * <p>Information for an intent that is classified by the test workbench.</p>
- * @public
- */
-export interface IntentClassificationTestResultItem {
-    /**
-     * <p>The name of the intent.</p>
-     * @public
-     */
-    intentName: string | undefined;
-    /**
-     * <p>Indicates whether the conversation involves multiple turns or not.</p>
-     * @public
-     */
-    multiTurnConversation: boolean | undefined;
-    /**
-     * <p>The result of the intent classification test.</p>
-     * @public
-     */
-    resultCounts: IntentClassificationTestResultItemCounts | undefined;
-}
-/**
- * <p>Information for the results of the intent classification test. </p>
- * @public
- */
-export interface IntentClassificationTestResults {
-    /**
-     * <p>A list of the results for the intent classification test.</p>
-     * @public
-     */
-    items: IntentClassificationTestResultItem[] | undefined;
-}
-/**
- * <p>Filters the response from the <code>ListIntents</code>
- *          operation.</p>
- * @public
- */
-export interface IntentFilter {
-    /**
-     * <p>The name of the field to use for the filter.</p>
-     * @public
-     */
-    name: IntentFilterName | undefined;
-    /**
-     * <p>The value to use for the filter.</p>
-     * @public
-     */
-    values: string[] | undefined;
-    /**
-     * <p>The operator to use for the filter. Specify <code>EQ</code> when the
-     *          <code>ListIntents</code> operation should return only aliases that
-     *          equal the specified value. Specify <code>CO</code> when the
-     *          <code>ListIntents</code> operation should return aliases that
-     *          contain the specified value.</p>
-     * @public
-     */
-    operator: IntentFilterOperator | undefined;
-}
-/**
- * <p>Information about the counts for a slot resolution in the results of a test execution.</p>
- * @public
- */
-export interface SlotResolutionTestResultItemCounts {
-    /**
-     * <p>The total number of results.</p>
-     * @public
-     */
-    totalResultCount: number | undefined;
-    /**
-     * <p>The number of matched, mismatched and execution error results for speech transcription for the slot.</p>
-     * @public
-     */
-    speechTranscriptionResultCounts?: Partial<Record<TestResultMatchStatus, number>> | undefined;
-    /**
-     * <p>The number of matched and mismatched results for slot resolution for the slot.</p>
-     * @public
-     */
-    slotMatchResultCounts: Partial<Record<TestResultMatchStatus, number>> | undefined;
-}