@aws-sdk/client-bedrock 3.828.0 → 3.830.0

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

@@ -1,4 +1,143 @@
-import { ApplicationType, EvaluationConfig, EvaluationInferenceConfig, EvaluationJobStatus, EvaluationJobType, EvaluationOutputDataConfig } from "./models_0";
+import { ApplicationType, EvaluationConfig, EvaluationJobStatus, EvaluationJobType, EvaluationModelConfig, EvaluationOutputDataConfig, EvaluationPrecomputedRagSourceConfig, KnowledgeBaseConfig, Tag } from "./models_0";
+/**
+ * <p>Contains configuration details for retrieval of information and response generation.</p>
+ * @public
+ */
+export type RAGConfig = RAGConfig.KnowledgeBaseConfigMember | RAGConfig.PrecomputedRagSourceConfigMember | RAGConfig.$UnknownMember;
+/**
+ * @public
+ */
+export declare namespace RAGConfig {
+    /**
+     * <p>Contains configuration details for knowledge base retrieval and response generation.</p>
+     * @public
+     */
+    interface KnowledgeBaseConfigMember {
+        knowledgeBaseConfig: KnowledgeBaseConfig;
+        precomputedRagSourceConfig?: never;
+        $unknown?: never;
+    }
+    /**
+     * <p>Contains configuration details about the RAG source used to generate inference response data for a Knowledge Base evaluation job.</p>
+     * @public
+     */
+    interface PrecomputedRagSourceConfigMember {
+        knowledgeBaseConfig?: never;
+        precomputedRagSourceConfig: EvaluationPrecomputedRagSourceConfig;
+        $unknown?: never;
+    }
+    /**
+     * @public
+     */
+    interface $UnknownMember {
+        knowledgeBaseConfig?: never;
+        precomputedRagSourceConfig?: never;
+        $unknown: [string, any];
+    }
+    interface Visitor<T> {
+        knowledgeBaseConfig: (value: KnowledgeBaseConfig) => T;
+        precomputedRagSourceConfig: (value: EvaluationPrecomputedRagSourceConfig) => T;
+        _: (name: string, value: any) => T;
+    }
+    const visit: <T>(value: RAGConfig, visitor: Visitor<T>) => T;
+}
+/**
+ * <p>The configuration details of the inference model for an evaluation job.</p> <p>For automated model evaluation jobs, only a single model is supported.</p> <p>For human-based model evaluation jobs, your annotator can compare the responses for up to two different models.</p>
+ * @public
+ */
+export type EvaluationInferenceConfig = EvaluationInferenceConfig.ModelsMember | EvaluationInferenceConfig.RagConfigsMember | EvaluationInferenceConfig.$UnknownMember;
+/**
+ * @public
+ */
+export declare namespace EvaluationInferenceConfig {
+    /**
+     * <p>Specifies the inference models.</p>
+     * @public
+     */
+    interface ModelsMember {
+        models: EvaluationModelConfig[];
+        ragConfigs?: never;
+        $unknown?: never;
+    }
+    /**
+     * <p>Contains the configuration details of the inference for a knowledge base evaluation job, including either the retrieval only configuration or the retrieval with response generation configuration.</p>
+     * @public
+     */
+    interface RagConfigsMember {
+        models?: never;
+        ragConfigs: RAGConfig[];
+        $unknown?: never;
+    }
+    /**
+     * @public
+     */
+    interface $UnknownMember {
+        models?: never;
+        ragConfigs?: never;
+        $unknown: [string, any];
+    }
+    interface Visitor<T> {
+        models: (value: EvaluationModelConfig[]) => T;
+        ragConfigs: (value: RAGConfig[]) => T;
+        _: (name: string, value: any) => T;
+    }
+    const visit: <T>(value: EvaluationInferenceConfig, visitor: Visitor<T>) => T;
+}
+/**
+ * @public
+ */
+export interface CreateEvaluationJobRequest {
+    /**
+     * <p>A name for the evaluation job. Names must unique with your Amazon Web Services account, and your account's Amazon Web Services region.</p>
+     * @public
+     */
+    jobName: string | undefined;
+    /**
+     * <p>A description of the evaluation job.</p>
+     * @public
+     */
+    jobDescription?: string | undefined;
+    /**
+     * <p>A unique, case-sensitive identifier to ensure that the API request completes no more than one time. If this token matches a previous request, Amazon Bedrock ignores the request, but does not return an error. For more information, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Run_Instance_Idempotency.html">Ensuring idempotency</a>.</p>
+     * @public
+     */
+    clientRequestToken?: string | undefined;
+    /**
+     * <p>The Amazon Resource Name (ARN) of an IAM service role that Amazon Bedrock can assume to perform tasks on your behalf. To learn more about the required permissions, see <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/model-evaluation-security.html">Required permissions for model evaluations</a>.</p>
+     * @public
+     */
+    roleArn: string | undefined;
+    /**
+     * <p>Specify your customer managed encryption key Amazon Resource Name (ARN) that will be used to encrypt your evaluation job.</p>
+     * @public
+     */
+    customerEncryptionKeyId?: string | undefined;
+    /**
+     * <p>Tags to attach to the model evaluation job.</p>
+     * @public
+     */
+    jobTags?: Tag[] | undefined;
+    /**
+     * <p>Specifies whether the evaluation job is for evaluating a model or evaluating a knowledge base (retrieval and response generation).</p>
+     * @public
+     */
+    applicationType?: ApplicationType | undefined;
+    /**
+     * <p>Contains the configuration details of either an automated or human-based evaluation job.</p>
+     * @public
+     */
+    evaluationConfig: EvaluationConfig | undefined;
+    /**
+     * <p>Contains the configuration details of the inference model for the evaluation job.</p> <p>For model evaluation jobs, automated jobs support a single model or <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/cross-region-inference.html">inference profile</a>, and jobs that use human workers support two models or inference profiles.</p>
+     * @public
+     */
+    inferenceConfig: EvaluationInferenceConfig | undefined;
+    /**
+     * <p>Contains the configuration details of the Amazon S3 bucket for storing the results of the evaluation job.</p>
+     * @public
+     */
+    outputDataConfig: EvaluationOutputDataConfig | undefined;
+}
 /**
  * @public
  */
@@ -54,8 +193,7 @@ export interface GetEvaluationJobResponse {
      */
     inferenceConfig: EvaluationInferenceConfig | undefined;
     /**
-     * <p>Contains the configuration details of the Amazon S3 bucket for
-     *          storing the results of the evaluation job.</p>
+     * <p>Contains the configuration details of the Amazon S3 bucket for storing the results of the evaluation job.</p>
      * @public
      */
     outputDataConfig: EvaluationOutputDataConfig | undefined;
@@ -75,6 +213,18 @@ export interface GetEvaluationJobResponse {
      */
     failureMessages?: string[] | undefined;
 }
+/**
+ * @internal
+ */
+export declare const RAGConfigFilterSensitiveLog: (obj: RAGConfig) => any;
+/**
+ * @internal
+ */
+export declare const EvaluationInferenceConfigFilterSensitiveLog: (obj: EvaluationInferenceConfig) => any;
+/**
+ * @internal
+ */
+export declare const CreateEvaluationJobRequestFilterSensitiveLog: (obj: CreateEvaluationJobRequest) => any;
 /**
  * @internal
  */

package/dist-types/protocols/Aws_restJson1.d.ts

@@ -1,6 +1,7 @@
 import { HttpRequest as __HttpRequest, HttpResponse as __HttpResponse } from "@smithy/protocol-http";
 import { SerdeContext as __SerdeContext } from "@smithy/types";
 import { BatchDeleteEvaluationJobCommandInput, BatchDeleteEvaluationJobCommandOutput } from "../commands/BatchDeleteEvaluationJobCommand";
+import { CreateCustomModelCommandInput, CreateCustomModelCommandOutput } from "../commands/CreateCustomModelCommand";
 import { CreateEvaluationJobCommandInput, CreateEvaluationJobCommandOutput } from "../commands/CreateEvaluationJobCommand";
 import { CreateGuardrailCommandInput, CreateGuardrailCommandOutput } from "../commands/CreateGuardrailCommand";
 import { CreateGuardrailVersionCommandInput, CreateGuardrailVersionCommandOutput } from "../commands/CreateGuardrailVersionCommand";
@@ -63,6 +64,10 @@ import { UpdateProvisionedModelThroughputCommandInput, UpdateProvisionedModelThr
  * serializeAws_restJson1BatchDeleteEvaluationJobCommand
  */
 export declare const se_BatchDeleteEvaluationJobCommand: (input: BatchDeleteEvaluationJobCommandInput, context: __SerdeContext) => Promise<__HttpRequest>;
+/**
+ * serializeAws_restJson1CreateCustomModelCommand
+ */
+export declare const se_CreateCustomModelCommand: (input: CreateCustomModelCommandInput, context: __SerdeContext) => Promise<__HttpRequest>;
 /**
  * serializeAws_restJson1CreateEvaluationJobCommand
  */
@@ -299,6 +304,10 @@ export declare const se_UpdateProvisionedModelThroughputCommand: (input: UpdateP
  * deserializeAws_restJson1BatchDeleteEvaluationJobCommand
  */
 export declare const de_BatchDeleteEvaluationJobCommand: (output: __HttpResponse, context: __SerdeContext) => Promise<BatchDeleteEvaluationJobCommandOutput>;
+/**
+ * deserializeAws_restJson1CreateCustomModelCommand
+ */
+export declare const de_CreateCustomModelCommand: (output: __HttpResponse, context: __SerdeContext) => Promise<CreateCustomModelCommandOutput>;
 /**
  * deserializeAws_restJson1CreateEvaluationJobCommand
  */

package/dist-types/runtimeConfig.browser.d.ts

@@ -15,8 +15,8 @@ export declare const getRuntimeConfig: (config: BedrockClientConfig) => {
     retryMode: string | import("@smithy/types").Provider<string>;
     sha256: import("@smithy/types").HashConstructor;
     streamCollector: import("@smithy/types").StreamCollector;
-    useDualstackEndpoint: boolean | import("@smithy/types").Provider<boolean>;
-    useFipsEndpoint: boolean | import("@smithy/types").Provider<boolean>;
+    useDualstackEndpoint: (boolean | import("@smithy/types").Provider<boolean>) & (boolean | import("@smithy/types").Provider<boolean | undefined>);
+    useFipsEndpoint: (boolean | import("@smithy/types").Provider<boolean>) & (boolean | import("@smithy/types").Provider<boolean | undefined>);
     apiVersion: string;
     cacheMiddleware?: boolean | undefined;
     urlParser: import("@smithy/types").UrlParser;

package/dist-types/runtimeConfig.native.d.ts

@@ -17,8 +17,8 @@ export declare const getRuntimeConfig: (config: BedrockClientConfig) => {
     utf8Encoder: (input: Uint8Array | string) => string;
     disableHostPrefix: boolean;
     serviceId: string;
-    useDualstackEndpoint: boolean | import("@smithy/types").Provider<boolean>;
-    useFipsEndpoint: boolean | import("@smithy/types").Provider<boolean>;
+    useDualstackEndpoint: (boolean | import("@smithy/types").Provider<boolean>) & (boolean | import("@smithy/types").Provider<boolean | undefined>);
+    useFipsEndpoint: (boolean | import("@smithy/types").Provider<boolean>) & (boolean | import("@smithy/types").Provider<boolean | undefined>);
     region: string | import("@smithy/types").Provider<any>;
     profile?: string;
     defaultUserAgentProvider: (config?: import("@aws-sdk/util-user-agent-browser").PreviouslyResolved) => Promise<import("@smithy/types").UserAgent>;

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

@@ -4,6 +4,10 @@ import {
   BatchDeleteEvaluationJobCommandInput,
   BatchDeleteEvaluationJobCommandOutput,
 } from "./commands/BatchDeleteEvaluationJobCommand";
+import {
+  CreateCustomModelCommandInput,
+  CreateCustomModelCommandOutput,
+} from "./commands/CreateCustomModelCommand";
 import {
   CreateEvaluationJobCommandInput,
   CreateEvaluationJobCommandOutput,
@@ -250,6 +254,19 @@ export interface Bedrock {
     options: __HttpHandlerOptions,
     cb: (err: any, data?: BatchDeleteEvaluationJobCommandOutput) => void
   ): void;
+  createCustomModel(
+    args: CreateCustomModelCommandInput,
+    options?: __HttpHandlerOptions
+  ): Promise<CreateCustomModelCommandOutput>;
+  createCustomModel(
+    args: CreateCustomModelCommandInput,
+    cb: (err: any, data?: CreateCustomModelCommandOutput) => void
+  ): void;
+  createCustomModel(
+    args: CreateCustomModelCommandInput,
+    options: __HttpHandlerOptions,
+    cb: (err: any, data?: CreateCustomModelCommandOutput) => void
+  ): void;
   createEvaluationJob(
     args: CreateEvaluationJobCommandInput,
     options?: __HttpHandlerOptions

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

@@ -49,6 +49,10 @@ import {
   BatchDeleteEvaluationJobCommandInput,
   BatchDeleteEvaluationJobCommandOutput,
 } from "./commands/BatchDeleteEvaluationJobCommand";
+import {
+  CreateCustomModelCommandInput,
+  CreateCustomModelCommandOutput,
+} from "./commands/CreateCustomModelCommand";
 import {
   CreateEvaluationJobCommandInput,
   CreateEvaluationJobCommandOutput,
@@ -290,6 +294,7 @@ import { RuntimeExtension, RuntimeExtensionsConfig } from "./runtimeExtensions";
 export { __Client };
 export type ServiceInputTypes =
   | BatchDeleteEvaluationJobCommandInput
+  | CreateCustomModelCommandInput
   | CreateEvaluationJobCommandInput
   | CreateGuardrailCommandInput
   | CreateGuardrailVersionCommandInput
@@ -350,6 +355,7 @@ export type ServiceInputTypes =
   | UpdateProvisionedModelThroughputCommandInput;
 export type ServiceOutputTypes =
   | BatchDeleteEvaluationJobCommandOutput
+  | CreateCustomModelCommandOutput
   | CreateEvaluationJobCommandOutput
   | CreateGuardrailCommandOutput
   | CreateGuardrailVersionCommandOutput

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

@@ -0,0 +1,51 @@
+import { Command as $Command } from "@smithy/smithy-client";
+import { MetadataBearer as __MetadataBearer } from "@smithy/types";
+import {
+  BedrockClientResolvedConfig,
+  ServiceInputTypes,
+  ServiceOutputTypes,
+} from "../BedrockClient";
+import {
+  CreateCustomModelRequest,
+  CreateCustomModelResponse,
+} from "../models/models_0";
+export { __MetadataBearer };
+export { $Command };
+export interface CreateCustomModelCommandInput
+  extends CreateCustomModelRequest {}
+export interface CreateCustomModelCommandOutput
+  extends CreateCustomModelResponse,
+    __MetadataBearer {}
+declare const CreateCustomModelCommand_base: {
+  new (
+    input: CreateCustomModelCommandInput
+  ): import("@smithy/smithy-client").CommandImpl<
+    CreateCustomModelCommandInput,
+    CreateCustomModelCommandOutput,
+    BedrockClientResolvedConfig,
+    ServiceInputTypes,
+    ServiceOutputTypes
+  >;
+  new (
+    input: CreateCustomModelCommandInput
+  ): import("@smithy/smithy-client").CommandImpl<
+    CreateCustomModelCommandInput,
+    CreateCustomModelCommandOutput,
+    BedrockClientResolvedConfig,
+    ServiceInputTypes,
+    ServiceOutputTypes
+  >;
+  getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
+};
+export declare class CreateCustomModelCommand extends CreateCustomModelCommand_base {
+  protected static __types: {
+    api: {
+      input: CreateCustomModelRequest;
+      output: CreateCustomModelResponse;
+    };
+    sdk: {
+      input: CreateCustomModelCommandInput;
+      output: CreateCustomModelCommandOutput;
+    };
+  };
+}

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

@@ -5,10 +5,8 @@ import {
   ServiceInputTypes,
   ServiceOutputTypes,
 } from "../BedrockClient";
-import {
-  CreateEvaluationJobRequest,
-  CreateEvaluationJobResponse,
-} from "../models/models_0";
+import { CreateEvaluationJobResponse } from "../models/models_0";
+import { CreateEvaluationJobRequest } from "../models/models_1";
 export { __MetadataBearer };
 export { $Command };
 export interface CreateEvaluationJobCommandInput

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

@@ -1,4 +1,5 @@
 export * from "./BatchDeleteEvaluationJobCommand";
+export * from "./CreateCustomModelCommand";
 export * from "./CreateEvaluationJobCommand";
 export * from "./CreateGuardrailCommand";
 export * from "./CreateGuardrailVersionCommand";

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

@@ -5,9 +5,9 @@ import {
   Provider,
 } from "@smithy/types";
 export interface ClientInputEndpointParameters {
-  region?: string | Provider<string>;
-  useDualstackEndpoint?: boolean | Provider<boolean>;
-  useFipsEndpoint?: boolean | Provider<boolean>;
+  region?: string | undefined | Provider<string | undefined>;
+  useDualstackEndpoint?: boolean | undefined | Provider<boolean | undefined>;
+  useFipsEndpoint?: boolean | undefined | Provider<boolean | undefined>;
   endpoint?:
     | string
     | Provider<string>
@@ -41,8 +41,8 @@ export declare const commonParams: {
   };
 };
 export interface EndpointParameters extends __EndpointParameters {
-  Region?: string;
-  UseDualStack?: boolean;
-  UseFIPS?: boolean;
-  Endpoint?: string;
+  Region?: string | undefined;
+  UseDualStack?: boolean | undefined;
+  UseFIPS?: boolean | undefined;
+  Endpoint?: string | undefined;
 }