@aws-sdk/client-bedrock-runtime 3.839.0 → 3.840.0

package/dist-types/auth/httpAuthExtensionConfiguration.d.ts

@@ -1,4 +1,4 @@
-import { AwsCredentialIdentity, AwsCredentialIdentityProvider, HttpAuthScheme } from "@smithy/types";
+import { AwsCredentialIdentity, AwsCredentialIdentityProvider, HttpAuthScheme, TokenIdentity, TokenIdentityProvider } from "@smithy/types";
 import { BedrockRuntimeHttpAuthSchemeProvider } from "./httpAuthSchemeProvider";
 /**
  * @internal
@@ -10,6 +10,8 @@ export interface HttpAuthExtensionConfiguration {
     httpAuthSchemeProvider(): BedrockRuntimeHttpAuthSchemeProvider;
     setCredentials(credentials: AwsCredentialIdentity | AwsCredentialIdentityProvider): void;
     credentials(): AwsCredentialIdentity | AwsCredentialIdentityProvider | undefined;
+    setToken(token: TokenIdentity | TokenIdentityProvider): void;
+    token(): TokenIdentity | TokenIdentityProvider | undefined;
 }
 /**
  * @internal
@@ -18,6 +20,7 @@ export type HttpAuthRuntimeConfig = Partial<{
     httpAuthSchemes: HttpAuthScheme[];
     httpAuthSchemeProvider: BedrockRuntimeHttpAuthSchemeProvider;
     credentials: AwsCredentialIdentity | AwsCredentialIdentityProvider;
+    token: TokenIdentity | TokenIdentityProvider;
 }>;
 /**
  * @internal

package/dist-types/auth/httpAuthSchemeProvider.d.ts

@@ -1,5 +1,5 @@
 import { AwsSdkSigV4AuthInputConfig, AwsSdkSigV4AuthResolvedConfig, AwsSdkSigV4PreviouslyResolved } from "@aws-sdk/core";
-import { HandlerExecutionContext, HttpAuthScheme, HttpAuthSchemeParameters, HttpAuthSchemeParametersProvider, HttpAuthSchemeProvider, Provider } from "@smithy/types";
+import { HandlerExecutionContext, HttpAuthScheme, HttpAuthSchemeParameters, HttpAuthSchemeParametersProvider, HttpAuthSchemeProvider, Provider, TokenIdentity, TokenIdentityProvider } from "@smithy/types";
 import { BedrockRuntimeClientResolvedConfig } from "../BedrockRuntimeClient";
 /**
  * @internal
@@ -46,6 +46,10 @@ export interface HttpAuthSchemeInputConfig extends AwsSdkSigV4AuthInputConfig {
      * @internal
      */
     httpAuthSchemeProvider?: BedrockRuntimeHttpAuthSchemeProvider;
+    /**
+     * The token used to authenticate requests.
+     */
+    token?: TokenIdentity | TokenIdentityProvider;
 }
 /**
  * @internal
@@ -68,6 +72,10 @@ export interface HttpAuthSchemeResolvedConfig extends AwsSdkSigV4AuthResolvedCon
      * @internal
      */
     readonly httpAuthSchemeProvider: BedrockRuntimeHttpAuthSchemeProvider;
+    /**
+     * The token used to authenticate requests.
+     */
+    readonly token?: TokenIdentityProvider;
 }
 /**
  * @internal

package/dist-types/commands/ApplyGuardrailCommand.d.ts

@@ -27,9 +27,7 @@ declare const ApplyGuardrailCommand_base: {
     getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
 };
 /**
- * <p>The action to apply a guardrail.</p>
- *          <p>For troubleshooting some of the common errors you might encounter when using the <code>ApplyGuardrail</code> API,
- *             see <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/troubleshooting-api-error-codes.html">Troubleshooting Amazon Bedrock API Error Codes</a> in the Amazon Bedrock User Guide</p>
+ * <p>The action to apply a guardrail.</p> <p>For troubleshooting some of the common errors you might encounter when using the <code>ApplyGuardrail</code> API, see <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/troubleshooting-api-error-codes.html">Troubleshooting Amazon Bedrock API Error Codes</a> in the Amazon Bedrock User Guide</p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript
@@ -192,27 +190,22 @@ declare const ApplyGuardrailCommand_base: {
  * @see {@link BedrockRuntimeClientResolvedConfig | config} for BedrockRuntimeClient's `config` shape.
  *
  * @throws {@link AccessDeniedException} (client fault)
- *  <p>The request is denied because you do not have sufficient permissions to perform the requested action. For troubleshooting this error,
- *          see <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/troubleshooting-api-error-codes.html#ts-access-denied">AccessDeniedException</a> in the Amazon Bedrock User Guide</p>
+ *  <p>The request is denied because you do not have sufficient permissions to perform the requested action. For troubleshooting this error, see <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/troubleshooting-api-error-codes.html#ts-access-denied">AccessDeniedException</a> in the Amazon Bedrock User Guide</p>
  *
  * @throws {@link InternalServerException} (server fault)
- *  <p>An internal server error occurred. For troubleshooting this error,
- *          see <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/troubleshooting-api-error-codes.html#ts-internal-failure">InternalFailure</a> in the Amazon Bedrock User Guide</p>
+ *  <p>An internal server error occurred. For troubleshooting this error, see <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/troubleshooting-api-error-codes.html#ts-internal-failure">InternalFailure</a> in the Amazon Bedrock User Guide</p>
  *
  * @throws {@link ResourceNotFoundException} (client fault)
- *  <p>The specified resource ARN was not found. For troubleshooting this error,
- *          see <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/troubleshooting-api-error-codes.html#ts-resource-not-found">ResourceNotFound</a> in the Amazon Bedrock User Guide</p>
+ *  <p>The specified resource ARN was not found. For troubleshooting this error, see <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/troubleshooting-api-error-codes.html#ts-resource-not-found">ResourceNotFound</a> in the Amazon Bedrock User Guide</p>
  *
  * @throws {@link ServiceQuotaExceededException} (client fault)
  *  <p>Your request exceeds the service quota for your account. You can view your quotas at <a href="https://docs.aws.amazon.com/servicequotas/latest/userguide/gs-request-quota.html">Viewing service quotas</a>. You can resubmit your request later.</p>
  *
  * @throws {@link ThrottlingException} (client fault)
- *  <p>Your request was denied due to exceeding the account quotas for <i>Amazon Bedrock</i>. For
- *          troubleshooting this error, see <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/troubleshooting-api-error-codes.html#ts-throttling-exception">ThrottlingException</a> in the Amazon Bedrock User Guide</p>
+ *  <p>Your request was denied due to exceeding the account quotas for <i>Amazon Bedrock</i>. For troubleshooting this error, see <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/troubleshooting-api-error-codes.html#ts-throttling-exception">ThrottlingException</a> in the Amazon Bedrock User Guide</p>
  *
  * @throws {@link ValidationException} (client fault)
- *  <p>The input fails to satisfy the constraints specified by <i>Amazon Bedrock</i>. For troubleshooting this error,
- *          see <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/troubleshooting-api-error-codes.html#ts-validation-error">ValidationError</a> in the Amazon Bedrock User Guide</p>
+ *  <p>The input fails to satisfy the constraints specified by <i>Amazon Bedrock</i>. For troubleshooting this error, see <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/troubleshooting-api-error-codes.html#ts-validation-error">ValidationError</a> in the Amazon Bedrock User Guide</p>
  *
  * @throws {@link BedrockRuntimeServiceException}
  * <p>Base exception class for all service exceptions from BedrockRuntime service.</p>

package/dist-types/commands/ConverseCommand.d.ts

@@ -27,30 +27,7 @@ declare const ConverseCommand_base: {
     getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
 };
 /**
- * <p>Sends messages to the specified Amazon Bedrock model. <code>Converse</code> provides
- *          a consistent interface that works with all models that
- *          support messages. This allows you to write code once and use it with different models.
- *          If a model has unique inference parameters, you can also pass those unique parameters
- *          to the model.</p>
- *          <p>Amazon Bedrock doesn't store any text, images, or documents that you provide as content. The data is only used to generate the response.</p>
- *          <p>You can submit a prompt by including it in the <code>messages</code> field, specifying the <code>modelId</code> of a foundation model or inference profile to run inference on it, and including any other fields that are relevant to your use case.</p>
- *          <p>You can also submit a prompt from Prompt management by specifying the ARN of the prompt version and including a map of variables to values in the <code>promptVariables</code> field. You can append more messages to the prompt by using the <code>messages</code> field. If you use a prompt from Prompt management, you can't include the following fields in the request: <code>additionalModelRequestFields</code>, <code>inferenceConfig</code>, <code>system</code>, or <code>toolConfig</code>. Instead, these fields must be defined through Prompt management. For more information, see <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/prompt-management-use.html">Use a prompt from Prompt management</a>.</p>
- *          <p>For information about the Converse API, see <i>Use the Converse API</i> in the <i>Amazon Bedrock User Guide</i>.
- *             To use a guardrail, see  <i>Use a guardrail with the Converse API</i> in the <i>Amazon Bedrock User Guide</i>.
- *             To use a tool with a model, see <i>Tool use (Function calling)</i> in the <i>Amazon Bedrock User Guide</i>
- *          </p>
- *          <p>For example code, see <i>Converse API examples</i> in the <i>Amazon Bedrock User Guide</i>.
- *       </p>
- *          <p>This operation requires permission for the <code>bedrock:InvokeModel</code> action. </p>
- *          <important>
- *             <p>To deny all inference access to resources that you specify in the modelId field, you
- *          need to deny access to the <code>bedrock:InvokeModel</code> and
- *          <code>bedrock:InvokeModelWithResponseStream</code> actions. Doing this also denies
- *          access to the resource through the base inference actions (<a href="https://docs.aws.amazon.com/bedrock/latest/APIReference/API_runtime_InvokeModel.html">InvokeModel</a> and <a href="https://docs.aws.amazon.com/bedrock/latest/APIReference/API_runtime_InvokeModelWithResponseStream.html">InvokeModelWithResponseStream</a>). For more information see <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/security_iam_id-based-policy-examples.html#security_iam_id-based-policy-examples-deny-inference">Deny access for inference on specific models</a>.
- *       </p>
- *          </important>
- *          <p>For troubleshooting some of the common errors you might encounter when using the <code>Converse</code> API,
- *          see <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/troubleshooting-api-error-codes.html">Troubleshooting Amazon Bedrock API Error Codes</a> in the Amazon Bedrock User Guide</p>
+ * <p>Sends messages to the specified Amazon Bedrock model. <code>Converse</code> provides a consistent interface that works with all models that support messages. This allows you to write code once and use it with different models. If a model has unique inference parameters, you can also pass those unique parameters to the model.</p> <p>Amazon Bedrock doesn't store any text, images, or documents that you provide as content. The data is only used to generate the response.</p> <p>You can submit a prompt by including it in the <code>messages</code> field, specifying the <code>modelId</code> of a foundation model or inference profile to run inference on it, and including any other fields that are relevant to your use case.</p> <p>You can also submit a prompt from Prompt management by specifying the ARN of the prompt version and including a map of variables to values in the <code>promptVariables</code> field. You can append more messages to the prompt by using the <code>messages</code> field. If you use a prompt from Prompt management, you can't include the following fields in the request: <code>additionalModelRequestFields</code>, <code>inferenceConfig</code>, <code>system</code>, or <code>toolConfig</code>. Instead, these fields must be defined through Prompt management. For more information, see <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/prompt-management-use.html">Use a prompt from Prompt management</a>.</p> <p>For information about the Converse API, see <i>Use the Converse API</i> in the <i>Amazon Bedrock User Guide</i>. To use a guardrail, see <i>Use a guardrail with the Converse API</i> in the <i>Amazon Bedrock User Guide</i>. To use a tool with a model, see <i>Tool use (Function calling)</i> in the <i>Amazon Bedrock User Guide</i> </p> <p>For example code, see <i>Converse API examples</i> in the <i>Amazon Bedrock User Guide</i>. </p> <p>This operation requires permission for the <code>bedrock:InvokeModel</code> action. </p> <important> <p>To deny all inference access to resources that you specify in the modelId field, you need to deny access to the <code>bedrock:InvokeModel</code> and <code>bedrock:InvokeModelWithResponseStream</code> actions. Doing this also denies access to the resource through the base inference actions (<a href="https://docs.aws.amazon.com/bedrock/latest/APIReference/API_runtime_InvokeModel.html">InvokeModel</a> and <a href="https://docs.aws.amazon.com/bedrock/latest/APIReference/API_runtime_InvokeModelWithResponseStream.html">InvokeModelWithResponseStream</a>). For more information see <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/security_iam_id-based-policy-examples.html#security_iam_id-based-policy-examples-deny-inference">Deny access for inference on specific models</a>. </p> </important> <p>For troubleshooting some of the common errors you might encounter when using the <code>Converse</code> API, see <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/troubleshooting-api-error-codes.html">Troubleshooting Amazon Bedrock API Error Codes</a> in the Amazon Bedrock User Guide</p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript
@@ -76,7 +53,7 @@ declare const ConverseCommand_base: {
  *             },
  *           },
  *           document: { // DocumentBlock
- *             format: "pdf" || "csv" || "doc" || "docx" || "xls" || "xlsx" || "html" || "txt" || "md", // required
+ *             format: "pdf" || "csv" || "doc" || "docx" || "xls" || "xlsx" || "html" || "txt" || "md",
  *             name: "STRING_VALUE", // required
  *             source: { // DocumentSource Union: only one key present
  *               bytes: new Uint8Array(), // e.g. Buffer.from("") or new TextEncoder().encode("")
@@ -84,6 +61,16 @@ declare const ConverseCommand_base: {
  *                 uri: "STRING_VALUE", // required
  *                 bucketOwner: "STRING_VALUE",
  *               },
+ *               text: "STRING_VALUE",
+ *               content: [ // DocumentContentBlocks
+ *                 { // DocumentContentBlock Union: only one key present
+ *                   text: "STRING_VALUE",
+ *                 },
+ *               ],
+ *             },
+ *             context: "STRING_VALUE",
+ *             citations: { // CitationsConfig
+ *               enabled: true || false, // required
  *             },
  *           },
  *           video: { // VideoBlock
@@ -118,7 +105,7 @@ declare const ConverseCommand_base: {
  *                   },
  *                 },
  *                 document: {
- *                   format: "pdf" || "csv" || "doc" || "docx" || "xls" || "xlsx" || "html" || "txt" || "md", // required
+ *                   format: "pdf" || "csv" || "doc" || "docx" || "xls" || "xlsx" || "html" || "txt" || "md",
  *                   name: "STRING_VALUE", // required
  *                   source: {//  Union: only one key present
  *                     bytes: new Uint8Array(), // e.g. Buffer.from("") or new TextEncoder().encode("")
@@ -126,6 +113,16 @@ declare const ConverseCommand_base: {
  *                       uri: "STRING_VALUE", // required
  *                       bucketOwner: "STRING_VALUE",
  *                     },
+ *                     text: "STRING_VALUE",
+ *                     content: [
+ *                       {//  Union: only one key present
+ *                         text: "STRING_VALUE",
+ *                       },
+ *                     ],
+ *                   },
+ *                   context: "STRING_VALUE",
+ *                   citations: {
+ *                     enabled: true || false, // required
  *                   },
  *                 },
  *                 video: {
@@ -163,6 +160,40 @@ declare const ConverseCommand_base: {
  *             },
  *             redactedContent: new Uint8Array(), // e.g. Buffer.from("") or new TextEncoder().encode("")
  *           },
+ *           citationsContent: { // CitationsContentBlock
+ *             content: [ // CitationGeneratedContentList
+ *               { // CitationGeneratedContent Union: only one key present
+ *                 text: "STRING_VALUE",
+ *               },
+ *             ],
+ *             citations: [ // Citations
+ *               { // Citation
+ *                 title: "STRING_VALUE",
+ *                 sourceContent: [ // CitationSourceContentList
+ *                   { // CitationSourceContent Union: only one key present
+ *                     text: "STRING_VALUE",
+ *                   },
+ *                 ],
+ *                 location: { // CitationLocation Union: only one key present
+ *                   documentChar: { // DocumentCharLocation
+ *                     documentIndex: Number("int"),
+ *                     start: Number("int"),
+ *                     end: Number("int"),
+ *                   },
+ *                   documentPage: { // DocumentPageLocation
+ *                     documentIndex: Number("int"),
+ *                     start: Number("int"),
+ *                     end: Number("int"),
+ *                   },
+ *                   documentChunk: { // DocumentChunkLocation
+ *                     documentIndex: Number("int"),
+ *                     start: Number("int"),
+ *                     end: Number("int"),
+ *                   },
+ *                 },
+ *               },
+ *             ],
+ *           },
  *         },
  *       ],
  *     },
@@ -259,7 +290,7 @@ declare const ConverseCommand_base: {
  * //             },
  * //           },
  * //           document: { // DocumentBlock
- * //             format: "pdf" || "csv" || "doc" || "docx" || "xls" || "xlsx" || "html" || "txt" || "md", // required
+ * //             format: "pdf" || "csv" || "doc" || "docx" || "xls" || "xlsx" || "html" || "txt" || "md",
  * //             name: "STRING_VALUE", // required
  * //             source: { // DocumentSource Union: only one key present
  * //               bytes: new Uint8Array(),
@@ -267,6 +298,16 @@ declare const ConverseCommand_base: {
  * //                 uri: "STRING_VALUE", // required
  * //                 bucketOwner: "STRING_VALUE",
  * //               },
+ * //               text: "STRING_VALUE",
+ * //               content: [ // DocumentContentBlocks
+ * //                 { // DocumentContentBlock Union: only one key present
+ * //                   text: "STRING_VALUE",
+ * //                 },
+ * //               ],
+ * //             },
+ * //             context: "STRING_VALUE",
+ * //             citations: { // CitationsConfig
+ * //               enabled: true || false, // required
  * //             },
  * //           },
  * //           video: { // VideoBlock
@@ -301,7 +342,7 @@ declare const ConverseCommand_base: {
  * //                   },
  * //                 },
  * //                 document: {
- * //                   format: "pdf" || "csv" || "doc" || "docx" || "xls" || "xlsx" || "html" || "txt" || "md", // required
+ * //                   format: "pdf" || "csv" || "doc" || "docx" || "xls" || "xlsx" || "html" || "txt" || "md",
  * //                   name: "STRING_VALUE", // required
  * //                   source: {//  Union: only one key present
  * //                     bytes: new Uint8Array(),
@@ -309,6 +350,16 @@ declare const ConverseCommand_base: {
  * //                       uri: "STRING_VALUE", // required
  * //                       bucketOwner: "STRING_VALUE",
  * //                     },
+ * //                     text: "STRING_VALUE",
+ * //                     content: [
+ * //                       {//  Union: only one key present
+ * //                         text: "STRING_VALUE",
+ * //                       },
+ * //                     ],
+ * //                   },
+ * //                   context: "STRING_VALUE",
+ * //                   citations: {
+ * //                     enabled: true || false, // required
  * //                   },
  * //                 },
  * //                 video: {
@@ -346,6 +397,40 @@ declare const ConverseCommand_base: {
  * //             },
  * //             redactedContent: new Uint8Array(),
  * //           },
+ * //           citationsContent: { // CitationsContentBlock
+ * //             content: [ // CitationGeneratedContentList
+ * //               { // CitationGeneratedContent Union: only one key present
+ * //                 text: "STRING_VALUE",
+ * //               },
+ * //             ],
+ * //             citations: [ // Citations
+ * //               { // Citation
+ * //                 title: "STRING_VALUE",
+ * //                 sourceContent: [ // CitationSourceContentList
+ * //                   { // CitationSourceContent Union: only one key present
+ * //                     text: "STRING_VALUE",
+ * //                   },
+ * //                 ],
+ * //                 location: { // CitationLocation Union: only one key present
+ * //                   documentChar: { // DocumentCharLocation
+ * //                     documentIndex: Number("int"),
+ * //                     start: Number("int"),
+ * //                     end: Number("int"),
+ * //                   },
+ * //                   documentPage: { // DocumentPageLocation
+ * //                     documentIndex: Number("int"),
+ * //                     start: Number("int"),
+ * //                     end: Number("int"),
+ * //                   },
+ * //                   documentChunk: { // DocumentChunkLocation
+ * //                     documentIndex: Number("int"),
+ * //                     start: Number("int"),
+ * //                     end: Number("int"),
+ * //                   },
+ * //                 },
+ * //               },
+ * //             ],
+ * //           },
  * //         },
  * //       ],
  * //     },
@@ -577,40 +662,31 @@ declare const ConverseCommand_base: {
  * @see {@link BedrockRuntimeClientResolvedConfig | config} for BedrockRuntimeClient's `config` shape.
  *
  * @throws {@link AccessDeniedException} (client fault)
- *  <p>The request is denied because you do not have sufficient permissions to perform the requested action. For troubleshooting this error,
- *          see <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/troubleshooting-api-error-codes.html#ts-access-denied">AccessDeniedException</a> in the Amazon Bedrock User Guide</p>
+ *  <p>The request is denied because you do not have sufficient permissions to perform the requested action. For troubleshooting this error, see <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/troubleshooting-api-error-codes.html#ts-access-denied">AccessDeniedException</a> in the Amazon Bedrock User Guide</p>
  *
  * @throws {@link InternalServerException} (server fault)
- *  <p>An internal server error occurred. For troubleshooting this error,
- *          see <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/troubleshooting-api-error-codes.html#ts-internal-failure">InternalFailure</a> in the Amazon Bedrock User Guide</p>
+ *  <p>An internal server error occurred. For troubleshooting this error, see <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/troubleshooting-api-error-codes.html#ts-internal-failure">InternalFailure</a> in the Amazon Bedrock User Guide</p>
  *
  * @throws {@link ModelErrorException} (client fault)
  *  <p>The request failed due to an error while processing the model.</p>
  *
  * @throws {@link ModelNotReadyException} (client fault)
- *  <p>The model specified in the request is not ready to serve inference requests. The AWS SDK
- *          will automatically retry the operation up to 5 times. For information about configuring
- *          automatic retries, see <a href="https://docs.aws.amazon.com/sdkref/latest/guide/feature-retry-behavior.html">Retry behavior</a> in the <i>AWS SDKs and Tools</i>
- *       reference guide.</p>
+ *  <p>The model specified in the request is not ready to serve inference requests. The AWS SDK will automatically retry the operation up to 5 times. For information about configuring automatic retries, see <a href="https://docs.aws.amazon.com/sdkref/latest/guide/feature-retry-behavior.html">Retry behavior</a> in the <i>AWS SDKs and Tools</i> reference guide.</p>
  *
  * @throws {@link ModelTimeoutException} (client fault)
  *  <p>The request took too long to process. Processing time exceeded the model timeout length.</p>
  *
  * @throws {@link ResourceNotFoundException} (client fault)
- *  <p>The specified resource ARN was not found. For troubleshooting this error,
- *          see <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/troubleshooting-api-error-codes.html#ts-resource-not-found">ResourceNotFound</a> in the Amazon Bedrock User Guide</p>
+ *  <p>The specified resource ARN was not found. For troubleshooting this error, see <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/troubleshooting-api-error-codes.html#ts-resource-not-found">ResourceNotFound</a> in the Amazon Bedrock User Guide</p>
  *
  * @throws {@link ServiceUnavailableException} (server fault)
- *  <p>The service isn't currently available. For troubleshooting this error,
- *          see <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/troubleshooting-api-error-codes.html#ts-service-unavailable">ServiceUnavailable</a> in the Amazon Bedrock User Guide</p>
+ *  <p>The service isn't currently available. For troubleshooting this error, see <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/troubleshooting-api-error-codes.html#ts-service-unavailable">ServiceUnavailable</a> in the Amazon Bedrock User Guide</p>
  *
  * @throws {@link ThrottlingException} (client fault)
- *  <p>Your request was denied due to exceeding the account quotas for <i>Amazon Bedrock</i>. For
- *          troubleshooting this error, see <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/troubleshooting-api-error-codes.html#ts-throttling-exception">ThrottlingException</a> in the Amazon Bedrock User Guide</p>
+ *  <p>Your request was denied due to exceeding the account quotas for <i>Amazon Bedrock</i>. For troubleshooting this error, see <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/troubleshooting-api-error-codes.html#ts-throttling-exception">ThrottlingException</a> in the Amazon Bedrock User Guide</p>
  *
  * @throws {@link ValidationException} (client fault)
- *  <p>The input fails to satisfy the constraints specified by <i>Amazon Bedrock</i>. For troubleshooting this error,
- *          see <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/troubleshooting-api-error-codes.html#ts-validation-error">ValidationError</a> in the Amazon Bedrock User Guide</p>
+ *  <p>The input fails to satisfy the constraints specified by <i>Amazon Bedrock</i>. For troubleshooting this error, see <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/troubleshooting-api-error-codes.html#ts-validation-error">ValidationError</a> in the Amazon Bedrock User Guide</p>
  *
  * @throws {@link BedrockRuntimeServiceException}
  * <p>Base exception class for all service exceptions from BedrockRuntime service.</p>

package/dist-types/commands/ConverseStreamCommand.d.ts

@@ -27,36 +27,7 @@ declare const ConverseStreamCommand_base: {
     getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
 };
 /**
- * <p>Sends messages to the specified Amazon Bedrock model and returns
- *          the response in a stream. <code>ConverseStream</code> provides a consistent API
- *          that works with all Amazon Bedrock models that support messages.
- *          This allows you to write code once and use it with different models. Should a
- *          model have unique inference parameters, you can also pass those unique parameters to the
- *          model. </p>
- *          <p>To find out if a model supports streaming, call <a href="https://docs.aws.amazon.com/bedrock/latest/APIReference/API_GetFoundationModel.html">GetFoundationModel</a>
- *          and check the <code>responseStreamingSupported</code> field in the response.</p>
- *          <note>
- *             <p>The CLI doesn't support streaming operations in Amazon Bedrock, including <code>ConverseStream</code>.</p>
- *          </note>
- *          <p>Amazon Bedrock doesn't store any text, images, or documents that you provide as content. The data is only used to generate the response.</p>
- *          <p>You can submit a prompt by including it in the <code>messages</code> field, specifying the <code>modelId</code> of a foundation model or inference profile to run inference on it, and including any other fields that are relevant to your use case.</p>
- *          <p>You can also submit a prompt from Prompt management by specifying the ARN of the prompt version and including a map of variables to values in the <code>promptVariables</code> field. You can append more messages to the prompt by using the <code>messages</code> field. If you use a prompt from Prompt management, you can't include the following fields in the request: <code>additionalModelRequestFields</code>, <code>inferenceConfig</code>, <code>system</code>, or <code>toolConfig</code>. Instead, these fields must be defined through Prompt management. For more information, see <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/prompt-management-use.html">Use a prompt from Prompt management</a>.</p>
- *          <p>For information about the Converse API, see <i>Use the Converse API</i> in the <i>Amazon Bedrock User Guide</i>.
- *          To use a guardrail, see  <i>Use a guardrail with the Converse API</i> in the <i>Amazon Bedrock User Guide</i>.
- *          To use a tool with a model, see <i>Tool use (Function calling)</i> in the <i>Amazon Bedrock User Guide</i>
- *          </p>
- *          <p>For example code, see <i>Conversation streaming example</i> in the <i>Amazon Bedrock User Guide</i>.
- *       </p>
- *          <p>This operation requires permission for the <code>bedrock:InvokeModelWithResponseStream</code> action.</p>
- *          <important>
- *             <p>To deny all inference access to resources that you specify in the modelId field, you
- *          need to deny access to the <code>bedrock:InvokeModel</code> and
- *          <code>bedrock:InvokeModelWithResponseStream</code> actions. Doing this also denies
- *          access to the resource through the base inference actions (<a href="https://docs.aws.amazon.com/bedrock/latest/APIReference/API_runtime_InvokeModel.html">InvokeModel</a> and <a href="https://docs.aws.amazon.com/bedrock/latest/APIReference/API_runtime_InvokeModelWithResponseStream.html">InvokeModelWithResponseStream</a>). For more information see <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/security_iam_id-based-policy-examples.html#security_iam_id-based-policy-examples-deny-inference">Deny access for inference on specific models</a>.
- *       </p>
- *          </important>
- *          <p>For troubleshooting some of the common errors you might encounter when using the <code>ConverseStream</code> API,
- *          see <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/troubleshooting-api-error-codes.html">Troubleshooting Amazon Bedrock API Error Codes</a> in the Amazon Bedrock User Guide</p>
+ * <p>Sends messages to the specified Amazon Bedrock model and returns the response in a stream. <code>ConverseStream</code> provides a consistent API that works with all Amazon Bedrock models that support messages. This allows you to write code once and use it with different models. Should a model have unique inference parameters, you can also pass those unique parameters to the model. </p> <p>To find out if a model supports streaming, call <a href="https://docs.aws.amazon.com/bedrock/latest/APIReference/API_GetFoundationModel.html">GetFoundationModel</a> and check the <code>responseStreamingSupported</code> field in the response.</p> <note> <p>The CLI doesn't support streaming operations in Amazon Bedrock, including <code>ConverseStream</code>.</p> </note> <p>Amazon Bedrock doesn't store any text, images, or documents that you provide as content. The data is only used to generate the response.</p> <p>You can submit a prompt by including it in the <code>messages</code> field, specifying the <code>modelId</code> of a foundation model or inference profile to run inference on it, and including any other fields that are relevant to your use case.</p> <p>You can also submit a prompt from Prompt management by specifying the ARN of the prompt version and including a map of variables to values in the <code>promptVariables</code> field. You can append more messages to the prompt by using the <code>messages</code> field. If you use a prompt from Prompt management, you can't include the following fields in the request: <code>additionalModelRequestFields</code>, <code>inferenceConfig</code>, <code>system</code>, or <code>toolConfig</code>. Instead, these fields must be defined through Prompt management. For more information, see <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/prompt-management-use.html">Use a prompt from Prompt management</a>.</p> <p>For information about the Converse API, see <i>Use the Converse API</i> in the <i>Amazon Bedrock User Guide</i>. To use a guardrail, see <i>Use a guardrail with the Converse API</i> in the <i>Amazon Bedrock User Guide</i>. To use a tool with a model, see <i>Tool use (Function calling)</i> in the <i>Amazon Bedrock User Guide</i> </p> <p>For example code, see <i>Conversation streaming example</i> in the <i>Amazon Bedrock User Guide</i>. </p> <p>This operation requires permission for the <code>bedrock:InvokeModelWithResponseStream</code> action.</p> <important> <p>To deny all inference access to resources that you specify in the modelId field, you need to deny access to the <code>bedrock:InvokeModel</code> and <code>bedrock:InvokeModelWithResponseStream</code> actions. Doing this also denies access to the resource through the base inference actions (<a href="https://docs.aws.amazon.com/bedrock/latest/APIReference/API_runtime_InvokeModel.html">InvokeModel</a> and <a href="https://docs.aws.amazon.com/bedrock/latest/APIReference/API_runtime_InvokeModelWithResponseStream.html">InvokeModelWithResponseStream</a>). For more information see <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/security_iam_id-based-policy-examples.html#security_iam_id-based-policy-examples-deny-inference">Deny access for inference on specific models</a>. </p> </important> <p>For troubleshooting some of the common errors you might encounter when using the <code>ConverseStream</code> API, see <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/troubleshooting-api-error-codes.html">Troubleshooting Amazon Bedrock API Error Codes</a> in the Amazon Bedrock User Guide</p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript
@@ -82,7 +53,7 @@ declare const ConverseStreamCommand_base: {
  *             },
  *           },
  *           document: { // DocumentBlock
- *             format: "pdf" || "csv" || "doc" || "docx" || "xls" || "xlsx" || "html" || "txt" || "md", // required
+ *             format: "pdf" || "csv" || "doc" || "docx" || "xls" || "xlsx" || "html" || "txt" || "md",
  *             name: "STRING_VALUE", // required
  *             source: { // DocumentSource Union: only one key present
  *               bytes: new Uint8Array(), // e.g. Buffer.from("") or new TextEncoder().encode("")
@@ -90,6 +61,16 @@ declare const ConverseStreamCommand_base: {
  *                 uri: "STRING_VALUE", // required
  *                 bucketOwner: "STRING_VALUE",
  *               },
+ *               text: "STRING_VALUE",
+ *               content: [ // DocumentContentBlocks
+ *                 { // DocumentContentBlock Union: only one key present
+ *                   text: "STRING_VALUE",
+ *                 },
+ *               ],
+ *             },
+ *             context: "STRING_VALUE",
+ *             citations: { // CitationsConfig
+ *               enabled: true || false, // required
  *             },
  *           },
  *           video: { // VideoBlock
@@ -124,7 +105,7 @@ declare const ConverseStreamCommand_base: {
  *                   },
  *                 },
  *                 document: {
- *                   format: "pdf" || "csv" || "doc" || "docx" || "xls" || "xlsx" || "html" || "txt" || "md", // required
+ *                   format: "pdf" || "csv" || "doc" || "docx" || "xls" || "xlsx" || "html" || "txt" || "md",
  *                   name: "STRING_VALUE", // required
  *                   source: {//  Union: only one key present
  *                     bytes: new Uint8Array(), // e.g. Buffer.from("") or new TextEncoder().encode("")
@@ -132,6 +113,16 @@ declare const ConverseStreamCommand_base: {
  *                       uri: "STRING_VALUE", // required
  *                       bucketOwner: "STRING_VALUE",
  *                     },
+ *                     text: "STRING_VALUE",
+ *                     content: [
+ *                       {//  Union: only one key present
+ *                         text: "STRING_VALUE",
+ *                       },
+ *                     ],
+ *                   },
+ *                   context: "STRING_VALUE",
+ *                   citations: {
+ *                     enabled: true || false, // required
  *                   },
  *                 },
  *                 video: {
@@ -169,6 +160,40 @@ declare const ConverseStreamCommand_base: {
  *             },
  *             redactedContent: new Uint8Array(), // e.g. Buffer.from("") or new TextEncoder().encode("")
  *           },
+ *           citationsContent: { // CitationsContentBlock
+ *             content: [ // CitationGeneratedContentList
+ *               { // CitationGeneratedContent Union: only one key present
+ *                 text: "STRING_VALUE",
+ *               },
+ *             ],
+ *             citations: [ // Citations
+ *               { // Citation
+ *                 title: "STRING_VALUE",
+ *                 sourceContent: [ // CitationSourceContentList
+ *                   { // CitationSourceContent Union: only one key present
+ *                     text: "STRING_VALUE",
+ *                   },
+ *                 ],
+ *                 location: { // CitationLocation Union: only one key present
+ *                   documentChar: { // DocumentCharLocation
+ *                     documentIndex: Number("int"),
+ *                     start: Number("int"),
+ *                     end: Number("int"),
+ *                   },
+ *                   documentPage: { // DocumentPageLocation
+ *                     documentIndex: Number("int"),
+ *                     start: Number("int"),
+ *                     end: Number("int"),
+ *                   },
+ *                   documentChunk: { // DocumentChunkLocation
+ *                     documentIndex: Number("int"),
+ *                     start: Number("int"),
+ *                     end: Number("int"),
+ *                   },
+ *                 },
+ *               },
+ *             ],
+ *           },
  *         },
  *       ],
  *     },
@@ -273,6 +298,31 @@ declare const ConverseStreamCommand_base: {
  * //           redactedContent: new Uint8Array(),
  * //           signature: "STRING_VALUE",
  * //         },
+ * //         citation: { // CitationsDelta
+ * //           title: "STRING_VALUE",
+ * //           sourceContent: [ // CitationSourceContentListDelta
+ * //             { // CitationSourceContentDelta
+ * //               text: "STRING_VALUE",
+ * //             },
+ * //           ],
+ * //           location: { // CitationLocation Union: only one key present
+ * //             documentChar: { // DocumentCharLocation
+ * //               documentIndex: Number("int"),
+ * //               start: Number("int"),
+ * //               end: Number("int"),
+ * //             },
+ * //             documentPage: { // DocumentPageLocation
+ * //               documentIndex: Number("int"),
+ * //               start: Number("int"),
+ * //               end: Number("int"),
+ * //             },
+ * //             documentChunk: { // DocumentChunkLocation
+ * //               documentIndex: Number("int"),
+ * //               start: Number("int"),
+ * //               end: Number("int"),
+ * //             },
+ * //           },
+ * //         },
  * //       },
  * //       contentBlockIndex: Number("int"), // required
  * //     },
@@ -528,40 +578,31 @@ declare const ConverseStreamCommand_base: {
  * @see {@link BedrockRuntimeClientResolvedConfig | config} for BedrockRuntimeClient's `config` shape.
  *
  * @throws {@link AccessDeniedException} (client fault)
- *  <p>The request is denied because you do not have sufficient permissions to perform the requested action. For troubleshooting this error,
- *          see <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/troubleshooting-api-error-codes.html#ts-access-denied">AccessDeniedException</a> in the Amazon Bedrock User Guide</p>
+ *  <p>The request is denied because you do not have sufficient permissions to perform the requested action. For troubleshooting this error, see <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/troubleshooting-api-error-codes.html#ts-access-denied">AccessDeniedException</a> in the Amazon Bedrock User Guide</p>
  *
  * @throws {@link InternalServerException} (server fault)
- *  <p>An internal server error occurred. For troubleshooting this error,
- *          see <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/troubleshooting-api-error-codes.html#ts-internal-failure">InternalFailure</a> in the Amazon Bedrock User Guide</p>
+ *  <p>An internal server error occurred. For troubleshooting this error, see <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/troubleshooting-api-error-codes.html#ts-internal-failure">InternalFailure</a> in the Amazon Bedrock User Guide</p>
  *
  * @throws {@link ModelErrorException} (client fault)
  *  <p>The request failed due to an error while processing the model.</p>
  *
  * @throws {@link ModelNotReadyException} (client fault)
- *  <p>The model specified in the request is not ready to serve inference requests. The AWS SDK
- *          will automatically retry the operation up to 5 times. For information about configuring
- *          automatic retries, see <a href="https://docs.aws.amazon.com/sdkref/latest/guide/feature-retry-behavior.html">Retry behavior</a> in the <i>AWS SDKs and Tools</i>
- *       reference guide.</p>
+ *  <p>The model specified in the request is not ready to serve inference requests. The AWS SDK will automatically retry the operation up to 5 times. For information about configuring automatic retries, see <a href="https://docs.aws.amazon.com/sdkref/latest/guide/feature-retry-behavior.html">Retry behavior</a> in the <i>AWS SDKs and Tools</i> reference guide.</p>
  *
  * @throws {@link ModelTimeoutException} (client fault)
  *  <p>The request took too long to process. Processing time exceeded the model timeout length.</p>
  *
  * @throws {@link ResourceNotFoundException} (client fault)
- *  <p>The specified resource ARN was not found. For troubleshooting this error,
- *          see <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/troubleshooting-api-error-codes.html#ts-resource-not-found">ResourceNotFound</a> in the Amazon Bedrock User Guide</p>
+ *  <p>The specified resource ARN was not found. For troubleshooting this error, see <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/troubleshooting-api-error-codes.html#ts-resource-not-found">ResourceNotFound</a> in the Amazon Bedrock User Guide</p>
  *
  * @throws {@link ServiceUnavailableException} (server fault)
- *  <p>The service isn't currently available. For troubleshooting this error,
- *          see <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/troubleshooting-api-error-codes.html#ts-service-unavailable">ServiceUnavailable</a> in the Amazon Bedrock User Guide</p>
+ *  <p>The service isn't currently available. For troubleshooting this error, see <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/troubleshooting-api-error-codes.html#ts-service-unavailable">ServiceUnavailable</a> in the Amazon Bedrock User Guide</p>
  *
  * @throws {@link ThrottlingException} (client fault)
- *  <p>Your request was denied due to exceeding the account quotas for <i>Amazon Bedrock</i>. For
- *          troubleshooting this error, see <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/troubleshooting-api-error-codes.html#ts-throttling-exception">ThrottlingException</a> in the Amazon Bedrock User Guide</p>
+ *  <p>Your request was denied due to exceeding the account quotas for <i>Amazon Bedrock</i>. For troubleshooting this error, see <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/troubleshooting-api-error-codes.html#ts-throttling-exception">ThrottlingException</a> in the Amazon Bedrock User Guide</p>
  *
  * @throws {@link ValidationException} (client fault)
- *  <p>The input fails to satisfy the constraints specified by <i>Amazon Bedrock</i>. For troubleshooting this error,
- *          see <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/troubleshooting-api-error-codes.html#ts-validation-error">ValidationError</a> in the Amazon Bedrock User Guide</p>
+ *  <p>The input fails to satisfy the constraints specified by <i>Amazon Bedrock</i>. For troubleshooting this error, see <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/troubleshooting-api-error-codes.html#ts-validation-error">ValidationError</a> in the Amazon Bedrock User Guide</p>
  *
  * @throws {@link BedrockRuntimeServiceException}
  * <p>Base exception class for all service exceptions from BedrockRuntime service.</p>

package/dist-types/commands/GetAsyncInvokeCommand.d.ts

@@ -66,20 +66,16 @@ declare const GetAsyncInvokeCommand_base: {
  * @see {@link BedrockRuntimeClientResolvedConfig | config} for BedrockRuntimeClient's `config` shape.
  *
  * @throws {@link AccessDeniedException} (client fault)
- *  <p>The request is denied because you do not have sufficient permissions to perform the requested action. For troubleshooting this error,
- *          see <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/troubleshooting-api-error-codes.html#ts-access-denied">AccessDeniedException</a> in the Amazon Bedrock User Guide</p>
+ *  <p>The request is denied because you do not have sufficient permissions to perform the requested action. For troubleshooting this error, see <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/troubleshooting-api-error-codes.html#ts-access-denied">AccessDeniedException</a> in the Amazon Bedrock User Guide</p>
  *
  * @throws {@link InternalServerException} (server fault)
- *  <p>An internal server error occurred. For troubleshooting this error,
- *          see <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/troubleshooting-api-error-codes.html#ts-internal-failure">InternalFailure</a> in the Amazon Bedrock User Guide</p>
+ *  <p>An internal server error occurred. For troubleshooting this error, see <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/troubleshooting-api-error-codes.html#ts-internal-failure">InternalFailure</a> in the Amazon Bedrock User Guide</p>
  *
  * @throws {@link ThrottlingException} (client fault)
- *  <p>Your request was denied due to exceeding the account quotas for <i>Amazon Bedrock</i>. For
- *          troubleshooting this error, see <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/troubleshooting-api-error-codes.html#ts-throttling-exception">ThrottlingException</a> in the Amazon Bedrock User Guide</p>
+ *  <p>Your request was denied due to exceeding the account quotas for <i>Amazon Bedrock</i>. For troubleshooting this error, see <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/troubleshooting-api-error-codes.html#ts-throttling-exception">ThrottlingException</a> in the Amazon Bedrock User Guide</p>
  *
  * @throws {@link ValidationException} (client fault)
- *  <p>The input fails to satisfy the constraints specified by <i>Amazon Bedrock</i>. For troubleshooting this error,
- *          see <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/troubleshooting-api-error-codes.html#ts-validation-error">ValidationError</a> in the Amazon Bedrock User Guide</p>
+ *  <p>The input fails to satisfy the constraints specified by <i>Amazon Bedrock</i>. For troubleshooting this error, see <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/troubleshooting-api-error-codes.html#ts-validation-error">ValidationError</a> in the Amazon Bedrock User Guide</p>
  *
  * @throws {@link BedrockRuntimeServiceException}
  * <p>Base exception class for all service exceptions from BedrockRuntime service.</p>