@aws-sdk/client-lex-runtime-v2 3.296.0 → 3.298.0

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

@@ -3,6 +3,7 @@ import { ExceptionOptionType as __ExceptionOptionType } from "@aws-sdk/smithy-cl
 import { Readable } from "stream";
 import { LexRuntimeV2ServiceException as __BaseException } from "./LexRuntimeV2ServiceException";
 /**
+ * @public
  * <p></p>
  */
 export declare class AccessDeniedException extends __BaseException {
@@ -14,6 +15,7 @@ export declare class AccessDeniedException extends __BaseException {
     constructor(opts: __ExceptionOptionType<AccessDeniedException, __BaseException>);
 }
 /**
+ * @public
  * <p>The time that a context is active. You can specify the time to live
  *          in seconds or in conversation turns.</p>
  */
@@ -30,6 +32,7 @@ export interface ActiveContextTimeToLive {
     turnsToLive: number | undefined;
 }
 /**
+ * @public
  * <p>Contains information about the contexts that a user is using in a
  *          session. You can configure Amazon Lex V2 to set a context when an intent is
  *          fulfilled, or you can set a context using the , , or  operations.</p>
@@ -61,6 +64,7 @@ export interface ActiveContext {
     contextAttributes: Record<string, string> | undefined;
 }
 /**
+ * @public
  * <p>Represents a chunk of audio sent from the client application to
  *          Amazon Lex V2. The audio is all or part of an utterance from the user.</p>
  *          <p>Amazon Lex V2 accumulates audio chunks until it recognizes a natural pause
@@ -93,6 +97,7 @@ export interface AudioInputEvent {
     clientTimestampMillis?: number;
 }
 /**
+ * @public
  * <p>An event sent from Amazon Lex V2 to your client application containing audio
  *          to play to the user. </p>
  */
@@ -116,6 +121,7 @@ export interface AudioResponseEvent {
     eventId?: string;
 }
 /**
+ * @public
  * <p></p>
  */
 export declare class ConflictException extends __BaseException {
@@ -126,6 +132,9 @@ export declare class ConflictException extends __BaseException {
      */
     constructor(opts: __ExceptionOptionType<ConflictException, __BaseException>);
 }
+/**
+ * @public
+ */
 export interface DeleteSessionRequest {
     /**
      * <p>The identifier of the bot that contains the session data.</p>
@@ -145,6 +154,9 @@ export interface DeleteSessionRequest {
      */
     sessionId: string | undefined;
 }
+/**
+ * @public
+ */
 export interface DeleteSessionResponse {
     /**
      * <p>The identifier of the bot that contained the session data.</p>
@@ -165,6 +177,7 @@ export interface DeleteSessionResponse {
     sessionId?: string;
 }
 /**
+ * @public
  * <p></p>
  */
 export declare class InternalServerException extends __BaseException {
@@ -176,6 +189,7 @@ export declare class InternalServerException extends __BaseException {
     constructor(opts: __ExceptionOptionType<InternalServerException, __BaseException>);
 }
 /**
+ * @public
  * <p></p>
  */
 export declare class ResourceNotFoundException extends __BaseException {
@@ -187,6 +201,7 @@ export declare class ResourceNotFoundException extends __BaseException {
     constructor(opts: __ExceptionOptionType<ResourceNotFoundException, __BaseException>);
 }
 /**
+ * @public
  * <p></p>
  */
 export declare class ThrottlingException extends __BaseException {
@@ -198,6 +213,7 @@ export declare class ThrottlingException extends __BaseException {
     constructor(opts: __ExceptionOptionType<ThrottlingException, __BaseException>);
 }
 /**
+ * @public
  * <p></p>
  */
 export declare class ValidationException extends __BaseException {
@@ -208,6 +224,9 @@ export declare class ValidationException extends __BaseException {
      */
     constructor(opts: __ExceptionOptionType<ValidationException, __BaseException>);
 }
+/**
+ * @public
+ */
 export interface GetSessionRequest {
     /**
      * <p>The identifier of the bot that contains the session data.</p>
@@ -227,17 +246,24 @@ export interface GetSessionRequest {
      */
     sessionId: string | undefined;
 }
+/**
+ * @public
+ */
 export declare enum ConfirmationState {
     CONFIRMED = "Confirmed",
     DENIED = "Denied",
     NONE = "None"
 }
+/**
+ * @public
+ */
 export declare enum Shape {
     COMPOSITE = "Composite",
     LIST = "List",
     SCALAR = "Scalar"
 }
 /**
+ * @public
  * <p>The value of a slot.</p>
  */
 export interface Value {
@@ -259,6 +285,9 @@ export interface Value {
      */
     resolvedValues?: string[];
 }
+/**
+ * @public
+ */
 export declare enum IntentState {
     FAILED = "Failed",
     FULFILLED = "Fulfilled",
@@ -268,6 +297,7 @@ export declare enum IntentState {
     WAITING = "Waiting"
 }
 /**
+ * @public
  * <p>Provides a score that indicates the confidence that Amazon Lex V2 has that
  *          an intent is the one that satisfies the user's intent.</p>
  */
@@ -279,6 +309,9 @@ export interface ConfidenceScore {
      */
     score?: number;
 }
+/**
+ * @public
+ */
 export declare enum SentimentType {
     MIXED = "MIXED",
     NEGATIVE = "NEGATIVE",
@@ -286,6 +319,7 @@ export declare enum SentimentType {
     POSITIVE = "POSITIVE"
 }
 /**
+ * @public
  * <p>The individual sentiment responses for the utterance.</p>
  */
 export interface SentimentScore {
@@ -311,6 +345,7 @@ export interface SentimentScore {
     mixed?: number;
 }
 /**
+ * @public
  * <p>Provides information about the sentiment expressed in a user's
  *          response in a conversation. Sentiments are determined using Amazon
  *          Comprehend. Sentiments are only returned if they are enabled for the
@@ -331,6 +366,9 @@ export interface SentimentResponse {
      */
     sentimentScore?: SentimentScore;
 }
+/**
+ * @public
+ */
 export declare enum MessageContentType {
     CUSTOM_PAYLOAD = "CustomPayload",
     IMAGE_RESPONSE_CARD = "ImageResponseCard",
@@ -338,6 +376,7 @@ export declare enum MessageContentType {
     SSML = "SSML"
 }
 /**
+ * @public
  * <p>A button that appears on a response card show to the user.</p>
  */
 export interface Button {
@@ -351,6 +390,7 @@ export interface Button {
     value: string | undefined;
 }
 /**
+ * @public
  * <p>A card that is shown to the user by a messaging platform. You define
  *          the contents of the card, the card is displayed by the platform. </p>
  *          <p>When you use a response card, the response from the user is
@@ -382,6 +422,7 @@ export interface ImageResponseCard {
     buttons?: Button[];
 }
 /**
+ * @public
  * <p>Container for text that is returned to the customer..</p>
  */
 export interface Message {
@@ -401,11 +442,17 @@ export interface Message {
      */
     imageResponseCard?: ImageResponseCard;
 }
+/**
+ * @public
+ */
 export declare enum StyleType {
     DEFAULT = "Default",
     SPELL_BY_LETTER = "SpellByLetter",
     SPELL_BY_WORD = "SpellByWord"
 }
+/**
+ * @public
+ */
 export declare enum DialogActionType {
     CLOSE = "Close",
     CONFIRM_INTENT = "ConfirmIntent",
@@ -415,6 +462,7 @@ export declare enum DialogActionType {
     NONE = "None"
 }
 /**
+ * @public
  * <p>Provides the phrase that Amazon Lex V2 should look for in the user's input
  *          to the bot.</p>
  */
@@ -426,6 +474,7 @@ export interface RuntimeHintValue {
     phrase: string | undefined;
 }
 /**
+ * @public
  * <p></p>
  */
 export declare class BadGatewayException extends __BaseException {
@@ -437,6 +486,7 @@ export declare class BadGatewayException extends __BaseException {
     constructor(opts: __ExceptionOptionType<BadGatewayException, __BaseException>);
 }
 /**
+ * @public
  * <p></p>
  */
 export declare class DependencyFailedException extends __BaseException {
@@ -447,6 +497,9 @@ export declare class DependencyFailedException extends __BaseException {
      */
     constructor(opts: __ExceptionOptionType<DependencyFailedException, __BaseException>);
 }
+/**
+ * @public
+ */
 export interface PutSessionResponse {
     /**
      * <p>The type of response. Same as the type specified in the
@@ -483,6 +536,7 @@ export interface PutSessionResponse {
     audioStream?: Readable | ReadableStream | Blob;
 }
 /**
+ * @public
  * <p>The bot member that processes the request.</p>
  */
 export interface RecognizedBotMember {
@@ -495,6 +549,9 @@ export interface RecognizedBotMember {
      */
     botName?: string;
 }
+/**
+ * @public
+ */
 export interface RecognizeUtteranceRequest {
     /**
      * <p>The identifier of the bot that should receive the request.</p>
@@ -621,6 +678,9 @@ export interface RecognizeUtteranceRequest {
      */
     inputStream?: Readable | ReadableStream | Blob;
 }
+/**
+ * @public
+ */
 export interface RecognizeUtteranceResponse {
     /**
      * <p>Indicates whether the input mode to the operation was text or
@@ -709,11 +769,15 @@ export interface RecognizeUtteranceResponse {
      */
     recognizedBotMember?: string;
 }
+/**
+ * @public
+ */
 export declare enum ConversationMode {
     AUDIO = "AUDIO",
     TEXT = "TEXT"
 }
 /**
+ * @public
  * <p>A notification from the client that it is disconnecting from Amazon Lex V2.
  *          Sending a <code>DisconnectionEvent</code> event is optional, but can
  *          help identify a conversation in logs.</p>
@@ -731,6 +795,7 @@ export interface DisconnectionEvent {
     clientTimestampMillis?: number;
 }
 /**
+ * @public
  * <p>A DTMF character sent from the client application. DTMF characters
  *          are typically sent from a phone keypad to represent numbers. For
  *          example, you can have Amazon Lex V2 process a credit card number input from a
@@ -754,6 +819,7 @@ export interface DTMFInputEvent {
     clientTimestampMillis?: number;
 }
 /**
+ * @public
  * <p>Event sent from the client application to Amazon Lex V2 to indicate that
  *          playback of audio is complete and that Amazon Lex V2 should start processing
  *          the user's input.</p>
@@ -771,6 +837,7 @@ export interface PlaybackCompletionEvent {
     clientTimestampMillis?: number;
 }
 /**
+ * @public
  * <p>The event sent from your client application to Amazon Lex V2 with text input
  *          from the user.</p>
  */
@@ -792,6 +859,7 @@ export interface TextInputEvent {
     clientTimestampMillis?: number;
 }
 /**
+ * @public
  * <p>Event that Amazon Lex V2 sends to indicate that the stream is still open
  *          between the client application and Amazon Lex V2 </p>
  */
@@ -804,17 +872,24 @@ export interface HeartbeatEvent {
      */
     eventId?: string;
 }
+/**
+ * @public
+ */
 export declare enum InputMode {
     DTMF = "DTMF",
     SPEECH = "Speech",
     TEXT = "Text"
 }
+/**
+ * @public
+ */
 export declare enum PlaybackInterruptionReason {
     DTMF_START_DETECTED = "DTMF_START_DETECTED",
     TEXT_DETECTED = "TEXT_DETECTED",
     VOICE_START_DETECTED = "VOICE_START_DETECTED"
 }
 /**
+ * @public
  * <p>Event sent from Amazon Lex V2 to indicate to the client application should
  *          stop playback of audio. For example, if the client is playing a prompt
  *          that asks for the user's telephone number, the user might start to say
@@ -841,6 +916,7 @@ export interface PlaybackInterruptionEvent {
     eventId?: string;
 }
 /**
+ * @public
  * <p>The event sent from Amazon Lex V2 to your application with text to present
  *          to the user.</p>
  */
@@ -860,6 +936,7 @@ export interface TextResponseEvent {
     eventId?: string;
 }
 /**
+ * @public
  * <p>Event sent from Amazon Lex V2 to your client application that contains a
  *          transcript of voice audio. </p>
  */
@@ -877,6 +954,7 @@ export interface TranscriptEvent {
     eventId?: string;
 }
 /**
+ * @public
  * <p>The specific constituent sub slot of the composite slot to elicit in dialog action.</p>
  */
 export interface ElicitSubSlot {
@@ -890,6 +968,7 @@ export interface ElicitSubSlot {
     subSlotToElicit?: ElicitSubSlot;
 }
 /**
+ * @public
  * <p>The next action that Amazon Lex V2 should take.</p>
  */
 export interface DialogAction {
@@ -955,6 +1034,7 @@ export interface DialogAction {
     subSlotToElicit?: ElicitSubSlot;
 }
 /**
+ * @public
  * <p>Provides an array of phrases that should be given preference when
  *          resolving values for a slot.</p>
  */
@@ -974,6 +1054,7 @@ export interface RuntimeHintDetails {
     subSlotHints?: Record<string, RuntimeHintDetails>;
 }
 /**
+ * @public
  * <p>You can provide Amazon Lex V2 with hints to the phrases that a customer is
  *          likely to use for a slot. When a slot with hints is resolved, the
  *          phrases in the runtime hints are preferred in the resolution. You can
@@ -997,6 +1078,7 @@ export interface RuntimeHints {
     slotHints?: Record<string, Record<string, RuntimeHintDetails>>;
 }
 /**
+ * @public
  * <p>A value that Amazon Lex V2 uses to fulfill an intent. </p>
  */
 export interface Slot {
@@ -1023,6 +1105,7 @@ export interface Slot {
     subSlots?: Record<string, Slot>;
 }
 /**
+ * @public
  * <p>The current intent that Amazon Lex V2 is attempting to fulfill.</p>
  */
 export interface Intent {
@@ -1047,6 +1130,7 @@ export interface Intent {
     confirmationState?: ConfirmationState | string;
 }
 /**
+ * @public
  * <p>An intent that Amazon Lex V2 determined might satisfy the user's utterance.
  *          The intents are ordered by the confidence score. </p>
  */
@@ -1074,6 +1158,7 @@ export interface Interpretation {
     intent?: Intent;
 }
 /**
+ * @public
  * <p>The state of the user's session with Amazon Lex V2.</p>
  */
 export interface SessionState {
@@ -1109,6 +1194,7 @@ export interface SessionState {
     runtimeHints?: RuntimeHints;
 }
 /**
+ * @public
  * <p>The initial event sent from the application to Amazon Lex V2 to configure
  *          the conversation, including session and request attributes and the
  *          response content type.</p>
@@ -1201,6 +1287,9 @@ export interface ConfigurationEvent {
      */
     clientTimestampMillis?: number;
 }
+/**
+ * @public
+ */
 export interface PutSessionRequest {
     /**
      * <p>The identifier of the bot that receives the session data.</p>
@@ -1251,6 +1340,9 @@ export interface PutSessionRequest {
      */
     responseContentType?: string;
 }
+/**
+ * @public
+ */
 export interface RecognizeTextRequest {
     /**
      * <p>The identifier of the bot that processes the request.</p>
@@ -1288,10 +1380,14 @@ export interface RecognizeTextRequest {
     requestAttributes?: Record<string, string>;
 }
 /**
+ * @public
  * <p>Represents a stream of events between your application and
  *          Amazon Lex V2.</p>
  */
 export type StartConversationRequestEventStream = StartConversationRequestEventStream.AudioInputEventMember | StartConversationRequestEventStream.ConfigurationEventMember | StartConversationRequestEventStream.DTMFInputEventMember | StartConversationRequestEventStream.DisconnectionEventMember | StartConversationRequestEventStream.PlaybackCompletionEventMember | StartConversationRequestEventStream.TextInputEventMember | StartConversationRequestEventStream.$UnknownMember;
+/**
+ * @public
+ */
 export declare namespace StartConversationRequestEventStream {
     /**
      * <p>Configuration information sent from your client application to
@@ -1408,6 +1504,9 @@ export declare namespace StartConversationRequestEventStream {
     }
     const visit: <T>(value: StartConversationRequestEventStream, visitor: Visitor<T>) => T;
 }
+/**
+ * @public
+ */
 export interface StartConversationRequest {
     /**
      * <p>The identifier of the bot to process the request.</p>
@@ -1440,6 +1539,9 @@ export interface StartConversationRequest {
      */
     requestEventStream: AsyncIterable<StartConversationRequestEventStream> | undefined;
 }
+/**
+ * @public
+ */
 export interface GetSessionResponse {
     /**
      * <p>The identifier of the returned session.</p>
@@ -1470,6 +1572,7 @@ export interface GetSessionResponse {
     sessionState?: SessionState;
 }
 /**
+ * @public
  * <p>Contains the current state of the conversation between the client
  *          application and Amazon Lex V2.</p>
  */
@@ -1512,6 +1615,9 @@ export interface IntentResultEvent {
      */
     recognizedBotMember?: RecognizedBotMember;
 }
+/**
+ * @public
+ */
 export interface RecognizeTextResponse {
     /**
      * <p>A list of messages last sent to the user. The messages are ordered
@@ -1549,10 +1655,14 @@ export interface RecognizeTextResponse {
     recognizedBotMember?: RecognizedBotMember;
 }
 /**
+ * @public
  * <p>Represents a stream of events between Amazon Lex V2 and your
  *          application.</p>
  */
 export type StartConversationResponseEventStream = StartConversationResponseEventStream.AccessDeniedExceptionMember | StartConversationResponseEventStream.AudioResponseEventMember | StartConversationResponseEventStream.BadGatewayExceptionMember | StartConversationResponseEventStream.ConflictExceptionMember | StartConversationResponseEventStream.DependencyFailedExceptionMember | StartConversationResponseEventStream.HeartbeatEventMember | StartConversationResponseEventStream.IntentResultEventMember | StartConversationResponseEventStream.InternalServerExceptionMember | StartConversationResponseEventStream.PlaybackInterruptionEventMember | StartConversationResponseEventStream.ResourceNotFoundExceptionMember | StartConversationResponseEventStream.TextResponseEventMember | StartConversationResponseEventStream.ThrottlingExceptionMember | StartConversationResponseEventStream.TranscriptEventMember | StartConversationResponseEventStream.ValidationExceptionMember | StartConversationResponseEventStream.$UnknownMember;
+/**
+ * @public
+ */
 export declare namespace StartConversationResponseEventStream {
     /**
      * <p>Event sent from Amazon Lex V2 to indicate to the client application should
@@ -1889,6 +1999,9 @@ export declare namespace StartConversationResponseEventStream {
     }
     const visit: <T>(value: StartConversationResponseEventStream, visitor: Visitor<T>) => T;
 }
+/**
+ * @public
+ */
 export interface StartConversationResponse {
     /**
      * <p>Represents the stream of events from Amazon Lex V2 to your application. The
@@ -1896,74 +2009,18 @@ export interface StartConversationResponse {
      */
     responseEventStream?: AsyncIterable<StartConversationResponseEventStream>;
 }
-/**
- * @internal
- */
-export declare const ActiveContextTimeToLiveFilterSensitiveLog: (obj: ActiveContextTimeToLive) => any;
 /**
  * @internal
  */
 export declare const ActiveContextFilterSensitiveLog: (obj: ActiveContext) => any;
-/**
- * @internal
- */
-export declare const AudioInputEventFilterSensitiveLog: (obj: AudioInputEvent) => any;
-/**
- * @internal
- */
-export declare const AudioResponseEventFilterSensitiveLog: (obj: AudioResponseEvent) => any;
-/**
- * @internal
- */
-export declare const DeleteSessionRequestFilterSensitiveLog: (obj: DeleteSessionRequest) => any;
-/**
- * @internal
- */
-export declare const DeleteSessionResponseFilterSensitiveLog: (obj: DeleteSessionResponse) => any;
-/**
- * @internal
- */
-export declare const GetSessionRequestFilterSensitiveLog: (obj: GetSessionRequest) => any;
-/**
- * @internal
- */
-export declare const ValueFilterSensitiveLog: (obj: Value) => any;
-/**
- * @internal
- */
-export declare const ConfidenceScoreFilterSensitiveLog: (obj: ConfidenceScore) => any;
-/**
- * @internal
- */
-export declare const SentimentScoreFilterSensitiveLog: (obj: SentimentScore) => any;
-/**
- * @internal
- */
-export declare const SentimentResponseFilterSensitiveLog: (obj: SentimentResponse) => any;
-/**
- * @internal
- */
-export declare const ButtonFilterSensitiveLog: (obj: Button) => any;
-/**
- * @internal
- */
-export declare const ImageResponseCardFilterSensitiveLog: (obj: ImageResponseCard) => any;
 /**
  * @internal
  */
 export declare const MessageFilterSensitiveLog: (obj: Message) => any;
-/**
- * @internal
- */
-export declare const RuntimeHintValueFilterSensitiveLog: (obj: RuntimeHintValue) => any;
 /**
  * @internal
  */
 export declare const PutSessionResponseFilterSensitiveLog: (obj: PutSessionResponse) => any;
-/**
- * @internal
- */
-export declare const RecognizedBotMemberFilterSensitiveLog: (obj: RecognizedBotMember) => any;
 /**
  * @internal
  */
@@ -1972,66 +2029,18 @@ export declare const RecognizeUtteranceRequestFilterSensitiveLog: (obj: Recogniz
  * @internal
  */
 export declare const RecognizeUtteranceResponseFilterSensitiveLog: (obj: RecognizeUtteranceResponse) => any;
-/**
- * @internal
- */
-export declare const DisconnectionEventFilterSensitiveLog: (obj: DisconnectionEvent) => any;
 /**
  * @internal
  */
 export declare const DTMFInputEventFilterSensitiveLog: (obj: DTMFInputEvent) => any;
-/**
- * @internal
- */
-export declare const PlaybackCompletionEventFilterSensitiveLog: (obj: PlaybackCompletionEvent) => any;
 /**
  * @internal
  */
 export declare const TextInputEventFilterSensitiveLog: (obj: TextInputEvent) => any;
-/**
- * @internal
- */
-export declare const HeartbeatEventFilterSensitiveLog: (obj: HeartbeatEvent) => any;
-/**
- * @internal
- */
-export declare const PlaybackInterruptionEventFilterSensitiveLog: (obj: PlaybackInterruptionEvent) => any;
 /**
  * @internal
  */
 export declare const TextResponseEventFilterSensitiveLog: (obj: TextResponseEvent) => any;
-/**
- * @internal
- */
-export declare const TranscriptEventFilterSensitiveLog: (obj: TranscriptEvent) => any;
-/**
- * @internal
- */
-export declare const ElicitSubSlotFilterSensitiveLog: (obj: ElicitSubSlot) => any;
-/**
- * @internal
- */
-export declare const DialogActionFilterSensitiveLog: (obj: DialogAction) => any;
-/**
- * @internal
- */
-export declare const RuntimeHintDetailsFilterSensitiveLog: (obj: RuntimeHintDetails) => any;
-/**
- * @internal
- */
-export declare const RuntimeHintsFilterSensitiveLog: (obj: RuntimeHints) => any;
-/**
- * @internal
- */
-export declare const SlotFilterSensitiveLog: (obj: Slot) => any;
-/**
- * @internal
- */
-export declare const IntentFilterSensitiveLog: (obj: Intent) => any;
-/**
- * @internal
- */
-export declare const InterpretationFilterSensitiveLog: (obj: Interpretation) => any;
 /**
  * @internal
  */

package/dist-types/ts3.4/commands/RecognizeUtteranceCommand.d.ts

@@ -16,7 +16,7 @@ import {
   RecognizeUtteranceRequest,
   RecognizeUtteranceResponse,
 } from "../models/models_0";
-type RecognizeUtteranceCommandInputType = Pick<
+export type RecognizeUtteranceCommandInputType = Pick<
   RecognizeUtteranceRequest,
   Exclude<keyof RecognizeUtteranceRequest, "inputStream">
 > & {
@@ -47,4 +47,3 @@ export declare class RecognizeUtteranceCommand extends $Command<
   private serialize;
   private deserialize;
 }
-export {};