@aws-sdk/client-bedrock-runtime 3.422.1 → 3.425.0

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

@@ -1,120 +1,49 @@
-import { EndpointParameterInstructions } from "@smithy/middleware-endpoint";
-import { Command as $Command } from "@smithy/smithy-client";
-import { BlobPayloadInputTypes, Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as __MetadataBearer, MiddlewareStack } from "@smithy/types";
-import { Uint8ArrayBlobAdapter } from "@smithy/util-stream";
-import { BedrockRuntimeClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../BedrockRuntimeClient";
-import { InvokeModelRequest, InvokeModelResponse } from "../models/models_0";
-/**
- * @public
- */
-export { __MetadataBearer, $Command };
-/**
- * @public
- */
-export type InvokeModelCommandInputType = Pick<InvokeModelRequest, Exclude<keyof InvokeModelRequest, "body">> & {
-    body: BlobPayloadInputTypes;
-};
-/**
- * @public
- *
- * The input for {@link InvokeModelCommand}.
- */
-export interface InvokeModelCommandInput extends InvokeModelCommandInputType {
-}
-/**
- * @public
- */
-export type InvokeModelCommandOutputType = Pick<InvokeModelResponse, Exclude<keyof InvokeModelResponse, "body">> & {
-    body: Uint8ArrayBlobAdapter;
-};
-/**
- * @public
- *
- * The output of {@link InvokeModelCommand}.
- */
-export interface InvokeModelCommandOutput extends InvokeModelCommandOutputType, __MetadataBearer {
-}
-/**
- * @public
- * <p>Invokes the specified Bedrock model to run inference using the input provided in the request body.
- *          You use InvokeModel to run inference for text models, image models, and embedding models.</p>
- *          <p>For more information about invoking models, see Using the API in the <a href="https://d2eo22ngex1n9g.cloudfront.net/Documentation/BedrockUserGuide.pdf">Bedrock User Guide</a>.</p>
- *          <p>For example requests, see Examples (after the Errors section).</p>
- * @example
- * Use a bare-bones client and the command you need to make an API call.
- * ```javascript
- * import { BedrockRuntimeClient, InvokeModelCommand } from "@aws-sdk/client-bedrock-runtime"; // ES Modules import
- * // const { BedrockRuntimeClient, InvokeModelCommand } = require("@aws-sdk/client-bedrock-runtime"); // CommonJS import
- * const client = new BedrockRuntimeClient(config);
- * const input = { // InvokeModelRequest
- *   body: "BLOB_VALUE", // required
- *   contentType: "STRING_VALUE",
- *   accept: "STRING_VALUE",
- *   modelId: "STRING_VALUE", // required
- * };
- * const command = new InvokeModelCommand(input);
- * const response = await client.send(command);
- * // { // InvokeModelResponse
- * //   body: "BLOB_VALUE", // required
- * //   contentType: "STRING_VALUE", // required
- * // };
- *
- * ```
- *
- * @param InvokeModelCommandInput - {@link InvokeModelCommandInput}
- * @returns {@link InvokeModelCommandOutput}
- * @see {@link InvokeModelCommandInput} for command's `input` shape.
- * @see {@link InvokeModelCommandOutput} for command's `response` shape.
- * @see {@link BedrockRuntimeClientResolvedConfig | config} for BedrockRuntimeClient's `config` shape.
- *
- * @throws {@link AccessDeniedException} (client fault)
- *  <p>The request is denied because of missing access permissions.</p>
- *
- * @throws {@link InternalServerException} (server fault)
- *  <p>An internal server error occurred. Retry your request.</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.</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. Check the ARN and try your request again.</p>
- *
- * @throws {@link ServiceQuotaExceededException} (client fault)
- *  <p>The number of requests exceeds the service quota. Resubmit your request later.</p>
- *
- * @throws {@link ThrottlingException} (client fault)
- *  <p>The number of requests exceeds the limit. Resubmit your request later.</p>
- *
- * @throws {@link ValidationException} (client fault)
- *  <p>Input validation failed. Check your request parameters and retry the request.</p>
- *
- * @throws {@link BedrockRuntimeServiceException}
- * <p>Base exception class for all service exceptions from BedrockRuntime service.</p>
- *
- */
-export declare class InvokeModelCommand extends $Command<InvokeModelCommandInput, InvokeModelCommandOutput, BedrockRuntimeClientResolvedConfig> {
-    readonly input: InvokeModelCommandInput;
-    static getEndpointParameterInstructions(): EndpointParameterInstructions;
-    /**
-     * @public
-     */
-    constructor(input: InvokeModelCommandInput);
-    /**
-     * @internal
-     */
-    resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: BedrockRuntimeClientResolvedConfig, options?: __HttpHandlerOptions): Handler<InvokeModelCommandInput, InvokeModelCommandOutput>;
-    /**
-     * @internal
-     */
-    private serialize;
-    /**
-     * @internal
-     */
-    private deserialize;
-}
+import { EndpointParameterInstructions } from "@smithy/middleware-endpoint";
+import { Command as $Command } from "@smithy/smithy-client";
+import {
+  BlobPayloadInputTypes,
+  Handler,
+  HttpHandlerOptions as __HttpHandlerOptions,
+  MetadataBearer as __MetadataBearer,
+  MiddlewareStack,
+} from "@smithy/types";
+import { Uint8ArrayBlobAdapter } from "@smithy/util-stream";
+import {
+  BedrockRuntimeClientResolvedConfig,
+  ServiceInputTypes,
+  ServiceOutputTypes,
+} from "../BedrockRuntimeClient";
+import { InvokeModelRequest, InvokeModelResponse } from "../models/models_0";
+export { __MetadataBearer, $Command };
+export type InvokeModelCommandInputType = Pick<
+  InvokeModelRequest,
+  Exclude<keyof InvokeModelRequest, "body">
+> & {
+  body: BlobPayloadInputTypes;
+};
+export interface InvokeModelCommandInput extends InvokeModelCommandInputType {}
+export type InvokeModelCommandOutputType = Pick<
+  InvokeModelResponse,
+  Exclude<keyof InvokeModelResponse, "body">
+> & {
+  body: Uint8ArrayBlobAdapter;
+};
+export interface InvokeModelCommandOutput
+  extends InvokeModelCommandOutputType,
+    __MetadataBearer {}
+export declare class InvokeModelCommand extends $Command<
+  InvokeModelCommandInput,
+  InvokeModelCommandOutput,
+  BedrockRuntimeClientResolvedConfig
+> {
+  readonly input: InvokeModelCommandInput;
+  static getEndpointParameterInstructions(): EndpointParameterInstructions;
+  constructor(input: InvokeModelCommandInput);
+  resolveMiddleware(
+    clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>,
+    configuration: BedrockRuntimeClientResolvedConfig,
+    options?: __HttpHandlerOptions
+  ): Handler<InvokeModelCommandInput, InvokeModelCommandOutput>;
+  private serialize;
+  private deserialize;
+}

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

@@ -1,134 +1,49 @@
-import { EndpointParameterInstructions } from "@smithy/middleware-endpoint";
-import { Command as $Command } from "@smithy/smithy-client";
-import { BlobPayloadInputTypes, Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as __MetadataBearer, MiddlewareStack } from "@smithy/types";
-import { BedrockRuntimeClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../BedrockRuntimeClient";
-import { InvokeModelWithResponseStreamRequest, InvokeModelWithResponseStreamResponse } from "../models/models_0";
-/**
- * @public
- */
-export { __MetadataBearer, $Command };
-/**
- * @public
- */
-export type InvokeModelWithResponseStreamCommandInputType = Pick<InvokeModelWithResponseStreamRequest, Exclude<keyof InvokeModelWithResponseStreamRequest, "body">> & {
-    body: BlobPayloadInputTypes;
-};
-/**
- * @public
- *
- * The input for {@link InvokeModelWithResponseStreamCommand}.
- */
-export interface InvokeModelWithResponseStreamCommandInput extends InvokeModelWithResponseStreamCommandInputType {
-}
-/**
- * @public
- *
- * The output of {@link InvokeModelWithResponseStreamCommand}.
- */
-export interface InvokeModelWithResponseStreamCommandOutput extends InvokeModelWithResponseStreamResponse, __MetadataBearer {
-}
-/**
- * @public
- * <p>Invoke the specified Bedrock model to run inference using the input provided.
- *       Return the response in a stream.</p>
- *          <p>For more information about invoking models, see Using the API in the <a href="https://d2eo22ngex1n9g.cloudfront.net/Documentation/BedrockUserGuide.pdf">Bedrock User Guide</a>.</p>
- *          <p>For an example request and response, see Examples (after the Errors section).</p>
- * @example
- * Use a bare-bones client and the command you need to make an API call.
- * ```javascript
- * import { BedrockRuntimeClient, InvokeModelWithResponseStreamCommand } from "@aws-sdk/client-bedrock-runtime"; // ES Modules import
- * // const { BedrockRuntimeClient, InvokeModelWithResponseStreamCommand } = require("@aws-sdk/client-bedrock-runtime"); // CommonJS import
- * const client = new BedrockRuntimeClient(config);
- * const input = { // InvokeModelWithResponseStreamRequest
- *   body: "BLOB_VALUE", // required
- *   contentType: "STRING_VALUE",
- *   accept: "STRING_VALUE",
- *   modelId: "STRING_VALUE", // required
- * };
- * const command = new InvokeModelWithResponseStreamCommand(input);
- * const response = await client.send(command);
- * // { // InvokeModelWithResponseStreamResponse
- * //   body: { // ResponseStream Union: only one key present
- * //     chunk: { // PayloadPart
- * //       bytes: "BLOB_VALUE",
- * //     },
- * //     internalServerException: { // InternalServerException
- * //       message: "STRING_VALUE",
- * //     },
- * //     modelStreamErrorException: { // ModelStreamErrorException
- * //       message: "STRING_VALUE",
- * //       originalStatusCode: Number("int"),
- * //       originalMessage: "STRING_VALUE",
- * //     },
- * //     validationException: { // ValidationException
- * //       message: "STRING_VALUE",
- * //     },
- * //     throttlingException: { // ThrottlingException
- * //       message: "STRING_VALUE",
- * //     },
- * //   },
- * //   contentType: "STRING_VALUE", // required
- * // };
- *
- * ```
- *
- * @param InvokeModelWithResponseStreamCommandInput - {@link InvokeModelWithResponseStreamCommandInput}
- * @returns {@link InvokeModelWithResponseStreamCommandOutput}
- * @see {@link InvokeModelWithResponseStreamCommandInput} for command's `input` shape.
- * @see {@link InvokeModelWithResponseStreamCommandOutput} for command's `response` shape.
- * @see {@link BedrockRuntimeClientResolvedConfig | config} for BedrockRuntimeClient's `config` shape.
- *
- * @throws {@link AccessDeniedException} (client fault)
- *  <p>The request is denied because of missing access permissions.</p>
- *
- * @throws {@link InternalServerException} (server fault)
- *  <p>An internal server error occurred. Retry your request.</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.</p>
- *
- * @throws {@link ModelStreamErrorException} (client fault)
- *  <p>An error occurred while streaming the response.</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. Check the ARN and try your request again.</p>
- *
- * @throws {@link ServiceQuotaExceededException} (client fault)
- *  <p>The number of requests exceeds the service quota. Resubmit your request later.</p>
- *
- * @throws {@link ThrottlingException} (client fault)
- *  <p>The number of requests exceeds the limit. Resubmit your request later.</p>
- *
- * @throws {@link ValidationException} (client fault)
- *  <p>Input validation failed. Check your request parameters and retry the request.</p>
- *
- * @throws {@link BedrockRuntimeServiceException}
- * <p>Base exception class for all service exceptions from BedrockRuntime service.</p>
- *
- */
-export declare class InvokeModelWithResponseStreamCommand extends $Command<InvokeModelWithResponseStreamCommandInput, InvokeModelWithResponseStreamCommandOutput, BedrockRuntimeClientResolvedConfig> {
-    readonly input: InvokeModelWithResponseStreamCommandInput;
-    static getEndpointParameterInstructions(): EndpointParameterInstructions;
-    /**
-     * @public
-     */
-    constructor(input: InvokeModelWithResponseStreamCommandInput);
-    /**
-     * @internal
-     */
-    resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: BedrockRuntimeClientResolvedConfig, options?: __HttpHandlerOptions): Handler<InvokeModelWithResponseStreamCommandInput, InvokeModelWithResponseStreamCommandOutput>;
-    /**
-     * @internal
-     */
-    private serialize;
-    /**
-     * @internal
-     */
-    private deserialize;
-}
+import { EndpointParameterInstructions } from "@smithy/middleware-endpoint";
+import { Command as $Command } from "@smithy/smithy-client";
+import {
+  BlobPayloadInputTypes,
+  Handler,
+  HttpHandlerOptions as __HttpHandlerOptions,
+  MetadataBearer as __MetadataBearer,
+  MiddlewareStack,
+} from "@smithy/types";
+import {
+  BedrockRuntimeClientResolvedConfig,
+  ServiceInputTypes,
+  ServiceOutputTypes,
+} from "../BedrockRuntimeClient";
+import {
+  InvokeModelWithResponseStreamRequest,
+  InvokeModelWithResponseStreamResponse,
+} from "../models/models_0";
+export { __MetadataBearer, $Command };
+export type InvokeModelWithResponseStreamCommandInputType = Pick<
+  InvokeModelWithResponseStreamRequest,
+  Exclude<keyof InvokeModelWithResponseStreamRequest, "body">
+> & {
+  body: BlobPayloadInputTypes;
+};
+export interface InvokeModelWithResponseStreamCommandInput
+  extends InvokeModelWithResponseStreamCommandInputType {}
+export interface InvokeModelWithResponseStreamCommandOutput
+  extends InvokeModelWithResponseStreamResponse,
+    __MetadataBearer {}
+export declare class InvokeModelWithResponseStreamCommand extends $Command<
+  InvokeModelWithResponseStreamCommandInput,
+  InvokeModelWithResponseStreamCommandOutput,
+  BedrockRuntimeClientResolvedConfig
+> {
+  readonly input: InvokeModelWithResponseStreamCommandInput;
+  static getEndpointParameterInstructions(): EndpointParameterInstructions;
+  constructor(input: InvokeModelWithResponseStreamCommandInput);
+  resolveMiddleware(
+    clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>,
+    configuration: BedrockRuntimeClientResolvedConfig,
+    options?: __HttpHandlerOptions
+  ): Handler<
+    InvokeModelWithResponseStreamCommandInput,
+    InvokeModelWithResponseStreamCommandOutput
+  >;
+  private serialize;
+  private deserialize;
+}

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

@@ -1,2 +1,2 @@
-export * from "./InvokeModelCommand";
-export * from "./InvokeModelWithResponseStreamCommand";
+export * from "./InvokeModelCommand";
+export * from "./InvokeModelWithResponseStreamCommand";

package/dist-types/ts3.4/endpoint/EndpointParameters.d.ts

@@ -1,22 +1,33 @@
-import { Endpoint, EndpointParameters as __EndpointParameters, EndpointV2, Provider } from "@smithy/types";
-/**
- * @public
- */
-export interface ClientInputEndpointParameters {
-    region?: string | Provider<string>;
-    useDualstackEndpoint?: boolean | Provider<boolean>;
-    useFipsEndpoint?: boolean | Provider<boolean>;
-    endpoint?: string | Provider<string> | Endpoint | Provider<Endpoint> | EndpointV2 | Provider<EndpointV2>;
-}
-export type ClientResolvedEndpointParameters = ClientInputEndpointParameters & {
-    defaultSigningName: string;
-};
-export declare const resolveClientEndpointParameters: <T>(options: T & ClientInputEndpointParameters) => T & ClientInputEndpointParameters & {
-    defaultSigningName: string;
-};
-export interface EndpointParameters extends __EndpointParameters {
-    Region?: string;
-    UseDualStack?: boolean;
-    UseFIPS?: boolean;
-    Endpoint?: string;
-}
+import {
+  Endpoint,
+  EndpointParameters as __EndpointParameters,
+  EndpointV2,
+  Provider,
+} from "@smithy/types";
+export interface ClientInputEndpointParameters {
+  region?: string | Provider<string>;
+  useDualstackEndpoint?: boolean | Provider<boolean>;
+  useFipsEndpoint?: boolean | Provider<boolean>;
+  endpoint?:
+    | string
+    | Provider<string>
+    | Endpoint
+    | Provider<Endpoint>
+    | EndpointV2
+    | Provider<EndpointV2>;
+}
+export type ClientResolvedEndpointParameters = ClientInputEndpointParameters & {
+  defaultSigningName: string;
+};
+export declare const resolveClientEndpointParameters: <T>(
+  options: T & ClientInputEndpointParameters
+) => T &
+  ClientInputEndpointParameters & {
+    defaultSigningName: string;
+  };
+export interface EndpointParameters extends __EndpointParameters {
+  Region?: string;
+  UseDualStack?: boolean;
+  UseFIPS?: boolean;
+  Endpoint?: string;
+}

package/dist-types/ts3.4/endpoint/endpointResolver.d.ts

@@ -1,5 +1,8 @@
-import { EndpointV2, Logger } from "@smithy/types";
-import { EndpointParameters } from "./EndpointParameters";
-export declare const defaultEndpointResolver: (endpointParams: EndpointParameters, context?: {
-    logger?: Logger;
-}) => EndpointV2;
+import { EndpointV2, Logger } from "@smithy/types";
+import { EndpointParameters } from "./EndpointParameters";
+export declare const defaultEndpointResolver: (
+  endpointParams: EndpointParameters,
+  context?: {
+    logger?: Logger;
+  }
+) => EndpointV2;

package/dist-types/ts3.4/endpoint/ruleset.d.ts

@@ -1,2 +1,2 @@
-import { RuleSetObject } from "@smithy/types";
-export declare const ruleSet: RuleSetObject;
+import { RuleSetObject } from "@smithy/types";
+export declare const ruleSet: RuleSetObject;

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

@@ -1,8 +1,7 @@
-import { AwsRegionExtensionConfiguration } from "@aws-sdk/types";
-import { HttpHandlerExtensionConfiguration } from "@smithy/protocol-http";
-import { DefaultExtensionConfiguration } from "@smithy/types";
-/**
- * @internal
- */
-export interface BedrockRuntimeExtensionConfiguration extends HttpHandlerExtensionConfiguration, DefaultExtensionConfiguration, AwsRegionExtensionConfiguration {
-}
+import { AwsRegionExtensionConfiguration } from "@aws-sdk/types";
+import { HttpHandlerExtensionConfiguration } from "@smithy/protocol-http";
+import { DefaultExtensionConfiguration } from "@smithy/types";
+export interface BedrockRuntimeExtensionConfiguration
+  extends HttpHandlerExtensionConfiguration,
+    DefaultExtensionConfiguration,
+    AwsRegionExtensionConfiguration {}

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

@@ -1,11 +1,6 @@
-/**
- * <p>Describes the API operations for running inference using Bedrock models.</p>
- *
- * @packageDocumentation
- */
-export * from "./BedrockRuntimeClient";
-export * from "./BedrockRuntime";
-export { ClientInputEndpointParameters } from "./endpoint/EndpointParameters";
-export * from "./commands";
-export * from "./models";
-export { BedrockRuntimeServiceException } from "./models/BedrockRuntimeServiceException";
+export * from "./BedrockRuntimeClient";
+export * from "./BedrockRuntime";
+export { ClientInputEndpointParameters } from "./endpoint/EndpointParameters";
+export * from "./commands";
+export * from "./models";
+export { BedrockRuntimeServiceException } from "./models/BedrockRuntimeServiceException";

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

@@ -1,13 +1,8 @@
-import { ServiceException as __ServiceException, ServiceExceptionOptions as __ServiceExceptionOptions } from "@smithy/smithy-client";
-export { __ServiceException, __ServiceExceptionOptions };
-/**
- * @public
- *
- * Base exception class for all service exceptions from BedrockRuntime service.
- */
-export declare class BedrockRuntimeServiceException extends __ServiceException {
-    /**
-     * @internal
-     */
-    constructor(options: __ServiceExceptionOptions);
-}
+import {
+  ServiceException as __ServiceException,
+  ServiceExceptionOptions as __ServiceExceptionOptions,
+} from "@smithy/smithy-client";
+export { __ServiceException, __ServiceExceptionOptions };
+export declare class BedrockRuntimeServiceException extends __ServiceException {
+  constructor(options: __ServiceExceptionOptions);
+}

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

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