@aws-sdk/client-lex-runtime-v2 3.186.0 → 3.186.2

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

@@ -1,35 +1,65 @@
-import { Command as $Command } from "@aws-sdk/smithy-client";
-import {
-  Handler,
-  HttpHandlerOptions as __HttpHandlerOptions,
-  MetadataBearer as __MetadataBearer,
-  MiddlewareStack,
-} from "@aws-sdk/types";
-import {
-  LexRuntimeV2ClientResolvedConfig,
-  ServiceInputTypes,
-  ServiceOutputTypes,
-} from "../LexRuntimeV2Client";
-import {
-  RecognizeTextRequest,
-  RecognizeTextResponse,
-} from "../models/models_0";
-export interface RecognizeTextCommandInput extends RecognizeTextRequest {}
-export interface RecognizeTextCommandOutput
-  extends RecognizeTextResponse,
-    __MetadataBearer {}
-export declare class RecognizeTextCommand extends $Command<
-  RecognizeTextCommandInput,
-  RecognizeTextCommandOutput,
-  LexRuntimeV2ClientResolvedConfig
-> {
-  readonly input: RecognizeTextCommandInput;
-  constructor(input: RecognizeTextCommandInput);
-  resolveMiddleware(
-    clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>,
-    configuration: LexRuntimeV2ClientResolvedConfig,
-    options?: __HttpHandlerOptions
-  ): Handler<RecognizeTextCommandInput, RecognizeTextCommandOutput>;
-  private serialize;
-  private deserialize;
-}
+import { Command as $Command } from "@aws-sdk/smithy-client";
+import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as __MetadataBearer, MiddlewareStack } from "@aws-sdk/types";
+import { LexRuntimeV2ClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../LexRuntimeV2Client";
+import { RecognizeTextRequest, RecognizeTextResponse } from "../models/models_0";
+export interface RecognizeTextCommandInput extends RecognizeTextRequest {
+}
+export interface RecognizeTextCommandOutput extends RecognizeTextResponse, __MetadataBearer {
+}
+/**
+ * <p>Sends user input to Amazon Lex V2. Client applications use this API to send
+ *          requests to Amazon Lex V2 at runtime. Amazon Lex V2 then interprets the user input
+ *          using the machine learning model that it build for the bot.</p>
+ *          <p>In response, Amazon Lex V2 returns the next message to convey to the user
+ *          and an optional response card to display.</p>
+ *          <p>If the optional post-fulfillment response is specified, the messages
+ *          are returned as follows. For more information, see <a href="https://docs.aws.amazon.com/lexv2/latest/dg/API_PostFulfillmentStatusSpecification.html">PostFulfillmentStatusSpecification</a>.</p>
+ *          <ul>
+ *             <li>
+ *                <p>
+ *                   <b>Success message</b> - Returned if
+ *                the Lambda function completes successfully and the intent state is
+ *                fulfilled or ready fulfillment if the message is present.</p>
+ *             </li>
+ *             <li>
+ *                <p>
+ *                   <b>Failed message</b> - The failed
+ *                message is returned if the Lambda function throws an exception or
+ *                if the Lambda function returns a failed intent state without a
+ *                message.</p>
+ *             </li>
+ *             <li>
+ *                <p>
+ *                   <b>Timeout message</b> - If you
+ *                don't configure a timeout message and a timeout, and the Lambda
+ *                function doesn't return within 30 seconds, the timeout message is
+ *                returned. If you configure a timeout, the timeout message is
+ *                returned when the period times out. </p>
+ *             </li>
+ *          </ul>
+ *          <p>For more information, see <a href="https://docs.aws.amazon.com/lexv2/latest/dg/streaming-progress.html#progress-complete.html">Completion message</a>.</p>
+ * @example
+ * Use a bare-bones client and the command you need to make an API call.
+ * ```javascript
+ * import { LexRuntimeV2Client, RecognizeTextCommand } from "@aws-sdk/client-lex-runtime-v2"; // ES Modules import
+ * // const { LexRuntimeV2Client, RecognizeTextCommand } = require("@aws-sdk/client-lex-runtime-v2"); // CommonJS import
+ * const client = new LexRuntimeV2Client(config);
+ * const command = new RecognizeTextCommand(input);
+ * const response = await client.send(command);
+ * ```
+ *
+ * @see {@link RecognizeTextCommandInput} for command's `input` shape.
+ * @see {@link RecognizeTextCommandOutput} for command's `response` shape.
+ * @see {@link LexRuntimeV2ClientResolvedConfig | config} for LexRuntimeV2Client's `config` shape.
+ *
+ */
+export declare class RecognizeTextCommand extends $Command<RecognizeTextCommandInput, RecognizeTextCommandOutput, LexRuntimeV2ClientResolvedConfig> {
+    readonly input: RecognizeTextCommandInput;
+    constructor(input: RecognizeTextCommandInput);
+    /**
+     * @internal
+     */
+    resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: LexRuntimeV2ClientResolvedConfig, options?: __HttpHandlerOptions): Handler<RecognizeTextCommandInput, RecognizeTextCommandOutput>;
+    private serialize;
+    private deserialize;
+}

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

@@ -1,47 +1,108 @@
-import { Command as $Command } from "@aws-sdk/smithy-client";
-import {
-  Handler,
-  HttpHandlerOptions as __HttpHandlerOptions,
-  MetadataBearer as __MetadataBearer,
-  MiddlewareStack,
-} from "@aws-sdk/types";
-import {
-  LexRuntimeV2ClientResolvedConfig,
-  ServiceInputTypes,
-  ServiceOutputTypes,
-} from "../LexRuntimeV2Client";
-import {
-  RecognizeUtteranceRequest,
-  RecognizeUtteranceResponse,
-} from "../models/models_0";
-declare type RecognizeUtteranceCommandInputType = Pick<
-  RecognizeUtteranceRequest,
-  Exclude<keyof RecognizeUtteranceRequest, "inputStream">
-> & {
-  inputStream?:
-    | RecognizeUtteranceRequest["inputStream"]
-    | string
-    | Uint8Array
-    | Buffer;
-};
-export interface RecognizeUtteranceCommandInput
-  extends RecognizeUtteranceCommandInputType {}
-export interface RecognizeUtteranceCommandOutput
-  extends RecognizeUtteranceResponse,
-    __MetadataBearer {}
-export declare class RecognizeUtteranceCommand extends $Command<
-  RecognizeUtteranceCommandInput,
-  RecognizeUtteranceCommandOutput,
-  LexRuntimeV2ClientResolvedConfig
-> {
-  readonly input: RecognizeUtteranceCommandInput;
-  constructor(input: RecognizeUtteranceCommandInput);
-  resolveMiddleware(
-    clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>,
-    configuration: LexRuntimeV2ClientResolvedConfig,
-    options?: __HttpHandlerOptions
-  ): Handler<RecognizeUtteranceCommandInput, RecognizeUtteranceCommandOutput>;
-  private serialize;
-  private deserialize;
-}
-export {};
+/// <reference types="node" />
+import { Command as $Command } from "@aws-sdk/smithy-client";
+import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as __MetadataBearer, MiddlewareStack } from "@aws-sdk/types";
+import { LexRuntimeV2ClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../LexRuntimeV2Client";
+import { RecognizeUtteranceRequest, RecognizeUtteranceResponse } from "../models/models_0";
+declare type RecognizeUtteranceCommandInputType = Pick<RecognizeUtteranceRequest, Exclude<keyof RecognizeUtteranceRequest, "inputStream">> & {
+    /**
+     * For *`RecognizeUtteranceRequest["inputStream"]`*, see {@link RecognizeUtteranceRequest.inputStream}.
+     */
+    inputStream?: RecognizeUtteranceRequest["inputStream"] | string | Uint8Array | Buffer;
+};
+/**
+ * This interface extends from `RecognizeUtteranceRequest` interface. There are more parameters than `inputStream` defined in {@link RecognizeUtteranceRequest}
+ */
+export interface RecognizeUtteranceCommandInput extends RecognizeUtteranceCommandInputType {
+}
+export interface RecognizeUtteranceCommandOutput extends RecognizeUtteranceResponse, __MetadataBearer {
+}
+/**
+ * <p>Sends user input to Amazon Lex V2. You can send text or speech. Clients use
+ *          this API to send text and audio requests to Amazon Lex V2 at runtime. Amazon Lex V2
+ *          interprets the user input using the machine learning model built for
+ *          the bot.</p>
+ *          <p>The following request fields must be compressed with gzip and then
+ *          base64 encoded before you send them to Amazon Lex V2. </p>
+ *          <ul>
+ *             <li>
+ *                <p>requestAttributes</p>
+ *             </li>
+ *             <li>
+ *                <p>sessionState</p>
+ *             </li>
+ *          </ul>
+ *          <p>The following response fields are compressed using gzip and then
+ *          base64 encoded by Amazon Lex V2. Before you can use these fields, you must
+ *          decode and decompress them. </p>
+ *          <ul>
+ *             <li>
+ *                <p>inputTranscript</p>
+ *             </li>
+ *             <li>
+ *                <p>interpretations</p>
+ *             </li>
+ *             <li>
+ *                <p>messages</p>
+ *             </li>
+ *             <li>
+ *                <p>requestAttributes</p>
+ *             </li>
+ *             <li>
+ *                <p>sessionState</p>
+ *             </li>
+ *          </ul>
+ *          <p>The example contains a Java application that compresses and encodes
+ *          a Java object to send to Amazon Lex V2, and a second that decodes and
+ *          decompresses a response from Amazon Lex V2.</p>
+ *          <p>If the optional post-fulfillment response is specified, the messages
+ *          are returned as follows. For more information, see <a href="https://docs.aws.amazon.com/lexv2/latest/dg/API_PostFulfillmentStatusSpecification.html">PostFulfillmentStatusSpecification</a>.</p>
+ *          <ul>
+ *             <li>
+ *                <p>
+ *                   <b>Success message</b> - Returned if
+ *                the Lambda function completes successfully and the intent state is
+ *                fulfilled or ready fulfillment if the message is present.</p>
+ *             </li>
+ *             <li>
+ *                <p>
+ *                   <b>Failed message</b> - The failed
+ *                message is returned if the Lambda function throws an exception or
+ *                if the Lambda function returns a failed intent state without a
+ *                message.</p>
+ *             </li>
+ *             <li>
+ *                <p>
+ *                   <b>Timeout message</b> - If you
+ *                don't configure a timeout message and a timeout, and the Lambda
+ *                function doesn't return within 30 seconds, the timeout message is
+ *                returned. If you configure a timeout, the timeout message is
+ *                returned when the period times out. </p>
+ *             </li>
+ *          </ul>
+ *          <p>For more information, see <a href="https://docs.aws.amazon.com/lexv2/latest/dg/streaming-progress.html#progress-complete.html">Completion message</a>.</p>
+ * @example
+ * Use a bare-bones client and the command you need to make an API call.
+ * ```javascript
+ * import { LexRuntimeV2Client, RecognizeUtteranceCommand } from "@aws-sdk/client-lex-runtime-v2"; // ES Modules import
+ * // const { LexRuntimeV2Client, RecognizeUtteranceCommand } = require("@aws-sdk/client-lex-runtime-v2"); // CommonJS import
+ * const client = new LexRuntimeV2Client(config);
+ * const command = new RecognizeUtteranceCommand(input);
+ * const response = await client.send(command);
+ * ```
+ *
+ * @see {@link RecognizeUtteranceCommandInput} for command's `input` shape.
+ * @see {@link RecognizeUtteranceCommandOutput} for command's `response` shape.
+ * @see {@link LexRuntimeV2ClientResolvedConfig | config} for LexRuntimeV2Client's `config` shape.
+ *
+ */
+export declare class RecognizeUtteranceCommand extends $Command<RecognizeUtteranceCommandInput, RecognizeUtteranceCommandOutput, LexRuntimeV2ClientResolvedConfig> {
+    readonly input: RecognizeUtteranceCommandInput;
+    constructor(input: RecognizeUtteranceCommandInput);
+    /**
+     * @internal
+     */
+    resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: LexRuntimeV2ClientResolvedConfig, options?: __HttpHandlerOptions): Handler<RecognizeUtteranceCommandInput, RecognizeUtteranceCommandOutput>;
+    private serialize;
+    private deserialize;
+}
+export {};

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

@@ -1,36 +1,94 @@
-import { Command as $Command } from "@aws-sdk/smithy-client";
-import {
-  Handler,
-  HttpHandlerOptions as __HttpHandlerOptions,
-  MetadataBearer as __MetadataBearer,
-  MiddlewareStack,
-} from "@aws-sdk/types";
-import {
-  LexRuntimeV2ClientResolvedConfig,
-  ServiceInputTypes,
-  ServiceOutputTypes,
-} from "../LexRuntimeV2Client";
-import {
-  StartConversationRequest,
-  StartConversationResponse,
-} from "../models/models_0";
-export interface StartConversationCommandInput
-  extends StartConversationRequest {}
-export interface StartConversationCommandOutput
-  extends StartConversationResponse,
-    __MetadataBearer {}
-export declare class StartConversationCommand extends $Command<
-  StartConversationCommandInput,
-  StartConversationCommandOutput,
-  LexRuntimeV2ClientResolvedConfig
-> {
-  readonly input: StartConversationCommandInput;
-  constructor(input: StartConversationCommandInput);
-  resolveMiddleware(
-    clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>,
-    configuration: LexRuntimeV2ClientResolvedConfig,
-    options?: __HttpHandlerOptions
-  ): Handler<StartConversationCommandInput, StartConversationCommandOutput>;
-  private serialize;
-  private deserialize;
-}
+import { Command as $Command } from "@aws-sdk/smithy-client";
+import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as __MetadataBearer, MiddlewareStack } from "@aws-sdk/types";
+import { LexRuntimeV2ClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../LexRuntimeV2Client";
+import { StartConversationRequest, StartConversationResponse } from "../models/models_0";
+export interface StartConversationCommandInput extends StartConversationRequest {
+}
+export interface StartConversationCommandOutput extends StartConversationResponse, __MetadataBearer {
+}
+/**
+ * <p>Starts an HTTP/2 bidirectional event stream that enables you to send
+ *          audio, text, or DTMF input in real time. After your application starts
+ *          a conversation, users send input to Amazon Lex V2 as a stream of events. Amazon Lex V2
+ *          processes the incoming events and responds with streaming text or audio
+ *          events.
+ *       </p>
+ *          <p>Audio input must be in the following format: <code>audio/lpcm
+ *             sample-rate=8000 sample-size-bits=16 channel-count=1;
+ *             is-big-endian=false</code>.</p>
+ *          <p>If the optional post-fulfillment response is specified, the messages
+ *          are returned as follows. For more information, see <a href="https://docs.aws.amazon.com/lexv2/latest/dg/API_PostFulfillmentStatusSpecification.html">PostFulfillmentStatusSpecification</a>.</p>
+ *          <ul>
+ *             <li>
+ *                <p>
+ *                   <b>Success message</b> - Returned if
+ *                the Lambda function completes successfully and the intent state is
+ *                fulfilled or ready fulfillment if the message is present.</p>
+ *             </li>
+ *             <li>
+ *                <p>
+ *                   <b>Failed message</b> - The failed
+ *                message is returned if the Lambda function throws an exception or
+ *                if the Lambda function returns a failed intent state without a
+ *                message.</p>
+ *             </li>
+ *             <li>
+ *                <p>
+ *                   <b>Timeout message</b> - If you
+ *                don't configure a timeout message and a timeout, and the Lambda
+ *                function doesn't return within 30 seconds, the timeout message is
+ *                returned. If you configure a timeout, the timeout message is
+ *                returned when the period times out. </p>
+ *             </li>
+ *          </ul>
+ *          <p>For more information, see <a href="https://docs.aws.amazon.com/lexv2/latest/dg/streaming-progress.html#progress-complete.html">Completion message</a>.</p>
+ *          <p>If the optional update message is configured, it is played at the
+ *          specified frequency while the Lambda function is running and the update
+ *          message state is active. If the fulfillment update message is not
+ *          active, the Lambda function runs with a 30 second timeout. </p>
+ *          <p>For more information, see <a href="https://docs.aws.amazon.com/lexv2/latest/dg/streaming-progress.html#progress-update.html">Update message </a>
+ *          </p>
+ *          <p>The <code>StartConversation</code> operation is supported only in
+ *          the following SDKs: </p>
+ *          <ul>
+ *             <li>
+ *                <p>
+ *                   <a href="https://docs.aws.amazon.com/goto/SdkForCpp/runtime.lex.v2-2020-08-07/StartConversation">AWS SDK for C++</a>
+ *                </p>
+ *             </li>
+ *             <li>
+ *                <p>
+ *                   <a href="https://docs.aws.amazon.com/goto/SdkForJavaV2/runtime.lex.v2-2020-08-07/StartConversation">AWS SDK for Java V2</a>
+ *                </p>
+ *             </li>
+ *             <li>
+ *                <p>
+ *                   <a href="https://docs.aws.amazon.com/goto/SdkForRubyV3/runtime.lex.v2-2020-08-07/StartConversation">AWS SDK for Ruby V3</a>
+ *                </p>
+ *             </li>
+ *          </ul>
+ * @example
+ * Use a bare-bones client and the command you need to make an API call.
+ * ```javascript
+ * import { LexRuntimeV2Client, StartConversationCommand } from "@aws-sdk/client-lex-runtime-v2"; // ES Modules import
+ * // const { LexRuntimeV2Client, StartConversationCommand } = require("@aws-sdk/client-lex-runtime-v2"); // CommonJS import
+ * const client = new LexRuntimeV2Client(config);
+ * const command = new StartConversationCommand(input);
+ * const response = await client.send(command);
+ * ```
+ *
+ * @see {@link StartConversationCommandInput} for command's `input` shape.
+ * @see {@link StartConversationCommandOutput} for command's `response` shape.
+ * @see {@link LexRuntimeV2ClientResolvedConfig | config} for LexRuntimeV2Client's `config` shape.
+ *
+ */
+export declare class StartConversationCommand extends $Command<StartConversationCommandInput, StartConversationCommandOutput, LexRuntimeV2ClientResolvedConfig> {
+    readonly input: StartConversationCommandInput;
+    constructor(input: StartConversationCommandInput);
+    /**
+     * @internal
+     */
+    resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: LexRuntimeV2ClientResolvedConfig, options?: __HttpHandlerOptions): Handler<StartConversationCommandInput, StartConversationCommandOutput>;
+    private serialize;
+    private deserialize;
+}

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

@@ -1,6 +1,6 @@
-export * from "./DeleteSessionCommand";
-export * from "./GetSessionCommand";
-export * from "./PutSessionCommand";
-export * from "./RecognizeTextCommand";
-export * from "./RecognizeUtteranceCommand";
-export * from "./StartConversationCommand";
+export * from "./DeleteSessionCommand";
+export * from "./GetSessionCommand";
+export * from "./PutSessionCommand";
+export * from "./RecognizeTextCommand";
+export * from "./RecognizeUtteranceCommand";
+export * from "./StartConversationCommand";

package/dist-types/ts3.4/endpoints.d.ts

@@ -1,2 +1,2 @@
-import { RegionInfoProvider } from "@aws-sdk/types";
-export declare const defaultRegionInfoProvider: RegionInfoProvider;
+import { RegionInfoProvider } from "@aws-sdk/types";
+export declare const defaultRegionInfoProvider: RegionInfoProvider;

package/dist-types/ts3.4/index.d.ts

@@ -1,5 +1,5 @@
-export * from "./LexRuntimeV2";
-export * from "./LexRuntimeV2Client";
-export * from "./commands";
-export * from "./models";
-export { LexRuntimeV2ServiceException } from "./models/LexRuntimeV2ServiceException";
+export * from "./LexRuntimeV2";
+export * from "./LexRuntimeV2Client";
+export * from "./commands";
+export * from "./models";
+export { LexRuntimeV2ServiceException } from "./models/LexRuntimeV2ServiceException";

package/dist-types/ts3.4/models/LexRuntimeV2ServiceException.d.ts

@@ -1,7 +1,10 @@
-import {
-  ServiceException as __ServiceException,
-  ServiceExceptionOptions as __ServiceExceptionOptions,
-} from "@aws-sdk/smithy-client";
-export declare class LexRuntimeV2ServiceException extends __ServiceException {
-  constructor(options: __ServiceExceptionOptions);
-}
+import { ServiceException as __ServiceException, ServiceExceptionOptions as __ServiceExceptionOptions } from "@aws-sdk/smithy-client";
+/**
+ * Base exception class for all service exceptions from LexRuntimeV2 service.
+ */
+export declare class LexRuntimeV2ServiceException extends __ServiceException {
+    /**
+     * @internal
+     */
+    constructor(options: __ServiceExceptionOptions);
+}

package/dist-types/ts3.4/models/index.d.ts

@@ -1 +1 @@
-export * from "./models_0";
+export * from "./models_0";