diff --git a/apidocs/README.md b/apidocs/README.md index 4ebdbcff..2e583823 100644 --- a/apidocs/README.md +++ b/apidocs/README.md @@ -31,11 +31,11 @@ - [AdapterProps](interfaces/AdapterProps.md) - [ContainerImageConfig](interfaces/ContainerImageConfig.md) - [CustomSageMakerEndpointProps](interfaces/CustomSageMakerEndpointProps.md) -- [IHuggingFaceSageMakerEndpointProps](interfaces/IHuggingFaceSageMakerEndpointProps.md) +- [HuggingFaceSageMakerEndpointProps](interfaces/HuggingFaceSageMakerEndpointProps.md) - [IInstanceAliase](interfaces/IInstanceAliase.md) - [IInstanceValiant](interfaces/IInstanceValiant.md) - [IJumpStartModelSpec](interfaces/IJumpStartModelSpec.md) -- [IJumpStartSageMakerEndpointProps](interfaces/IJumpStartSageMakerEndpointProps.md) +- [JumpStartSageMakerEndpointProps](interfaces/JumpStartSageMakerEndpointProps.md) - [LangchainLayerProps](interfaces/LangchainLayerProps.md) - [LangchainProps](interfaces/LangchainProps.md) - [QaAppsyncOpensearchProps](interfaces/QaAppsyncOpensearchProps.md) diff --git a/apidocs/classes/HuggingFaceSageMakerEndpoint.md b/apidocs/classes/HuggingFaceSageMakerEndpoint.md index be20329b..848932af 100644 --- a/apidocs/classes/HuggingFaceSageMakerEndpoint.md +++ b/apidocs/classes/HuggingFaceSageMakerEndpoint.md @@ -57,7 +57,7 @@ The HuggingFaceSageMakerEndpoint class. | :------ | :------ | | `scope` | `Construct` | | `id` | `string` | -| `props` | [`IHuggingFaceSageMakerEndpointProps`](../interfaces/IHuggingFaceSageMakerEndpointProps.md) | +| `props` | [`HuggingFaceSageMakerEndpointProps`](../interfaces/HuggingFaceSageMakerEndpointProps.md) | #### Returns diff --git a/apidocs/classes/JumpStartSageMakerEndpoint.md b/apidocs/classes/JumpStartSageMakerEndpoint.md index 7b6d5c74..e806813d 100644 --- a/apidocs/classes/JumpStartSageMakerEndpoint.md +++ b/apidocs/classes/JumpStartSageMakerEndpoint.md @@ -59,7 +59,7 @@ The JumpStartSageMakerEndpoint class. | :------ | :------ | | `scope` | `Construct` | | `id` | `string` | -| `props` | [`IJumpStartSageMakerEndpointProps`](../interfaces/IJumpStartSageMakerEndpointProps.md) | +| `props` | [`JumpStartSageMakerEndpointProps`](../interfaces/JumpStartSageMakerEndpointProps.md) | #### Returns diff --git a/apidocs/interfaces/HuggingFaceSageMakerEndpointProps.md b/apidocs/interfaces/HuggingFaceSageMakerEndpointProps.md new file mode 100644 index 00000000..0d0a51af --- /dev/null +++ b/apidocs/interfaces/HuggingFaceSageMakerEndpointProps.md @@ -0,0 +1,75 @@ +[@cdklabs/generative-ai-cdk-constructs](../README.md) / HuggingFaceSageMakerEndpointProps + +# Interface: HuggingFaceSageMakerEndpointProps + +## Table of contents + +### Properties + +- [container](HuggingFaceSageMakerEndpointProps.md#container) +- [endpointName](HuggingFaceSageMakerEndpointProps.md#endpointname) +- [environment](HuggingFaceSageMakerEndpointProps.md#environment) +- [instanceCount](HuggingFaceSageMakerEndpointProps.md#instancecount) +- [instanceType](HuggingFaceSageMakerEndpointProps.md#instancetype) +- [modelId](HuggingFaceSageMakerEndpointProps.md#modelid) +- [role](HuggingFaceSageMakerEndpointProps.md#role) +- [startupHealthCheckTimeoutInSeconds](HuggingFaceSageMakerEndpointProps.md#startuphealthchecktimeoutinseconds) +- [vpcConfig](HuggingFaceSageMakerEndpointProps.md#vpcconfig) + +## Properties + +### container + +• `Readonly` **container**: [`ContainerImage`](../classes/ContainerImage.md) + +___ + +### endpointName + +• `Optional` `Readonly` **endpointName**: `string` + +___ + +### environment + +• `Optional` `Readonly` **environment**: `Object` + +#### Index signature + +▪ [key: `string`]: `string` + +___ + +### instanceCount + +• `Optional` `Readonly` **instanceCount**: `number` + +___ + +### instanceType + +• `Readonly` **instanceType**: [`SageMakerInstanceType`](../classes/SageMakerInstanceType.md) + +___ + +### modelId + +• `Readonly` **modelId**: `string` + +___ + +### role + +• `Optional` `Readonly` **role**: `Role` + +___ + +### startupHealthCheckTimeoutInSeconds + +• `Optional` `Readonly` **startupHealthCheckTimeoutInSeconds**: `number` + +___ + +### vpcConfig + +• `Optional` `Readonly` **vpcConfig**: `VpcConfigProperty` diff --git a/apidocs/interfaces/IHuggingFaceSageMakerEndpointProps.md b/apidocs/interfaces/IHuggingFaceSageMakerEndpointProps.md deleted file mode 100644 index 259195f6..00000000 --- a/apidocs/interfaces/IHuggingFaceSageMakerEndpointProps.md +++ /dev/null @@ -1,75 +0,0 @@ -[@cdklabs/generative-ai-cdk-constructs](../README.md) / IHuggingFaceSageMakerEndpointProps - -# Interface: IHuggingFaceSageMakerEndpointProps - -## Table of contents - -### Properties - -- [container](IHuggingFaceSageMakerEndpointProps.md#container) -- [endpointName](IHuggingFaceSageMakerEndpointProps.md#endpointname) -- [environment](IHuggingFaceSageMakerEndpointProps.md#environment) -- [instanceCount](IHuggingFaceSageMakerEndpointProps.md#instancecount) -- [instanceType](IHuggingFaceSageMakerEndpointProps.md#instancetype) -- [modelId](IHuggingFaceSageMakerEndpointProps.md#modelid) -- [role](IHuggingFaceSageMakerEndpointProps.md#role) -- [startupHealthCheckTimeoutInSeconds](IHuggingFaceSageMakerEndpointProps.md#startuphealthchecktimeoutinseconds) -- [vpcConfig](IHuggingFaceSageMakerEndpointProps.md#vpcconfig) - -## Properties - -### container - -• **container**: [`ContainerImage`](../classes/ContainerImage.md) - -___ - -### endpointName - -• `Optional` **endpointName**: `string` - -___ - -### environment - -• `Optional` **environment**: `Object` - -#### Index signature - -▪ [key: `string`]: `string` - -___ - -### instanceCount - -• `Optional` **instanceCount**: `number` - -___ - -### instanceType - -• **instanceType**: [`SageMakerInstanceType`](../classes/SageMakerInstanceType.md) - -___ - -### modelId - -• **modelId**: `string` - -___ - -### role - -• `Optional` **role**: `Role` - -___ - -### startupHealthCheckTimeoutInSeconds - -• `Optional` **startupHealthCheckTimeoutInSeconds**: `number` - -___ - -### vpcConfig - -• `Optional` **vpcConfig**: `VpcConfigProperty` diff --git a/apidocs/interfaces/IJumpStartSageMakerEndpointProps.md b/apidocs/interfaces/IJumpStartSageMakerEndpointProps.md deleted file mode 100644 index 65dcd808..00000000 --- a/apidocs/interfaces/IJumpStartSageMakerEndpointProps.md +++ /dev/null @@ -1,68 +0,0 @@ -[@cdklabs/generative-ai-cdk-constructs](../README.md) / IJumpStartSageMakerEndpointProps - -# Interface: IJumpStartSageMakerEndpointProps - -## Table of contents - -### Properties - -- [endpointName](IJumpStartSageMakerEndpointProps.md#endpointname) -- [environment](IJumpStartSageMakerEndpointProps.md#environment) -- [instanceCount](IJumpStartSageMakerEndpointProps.md#instancecount) -- [instanceType](IJumpStartSageMakerEndpointProps.md#instancetype) -- [model](IJumpStartSageMakerEndpointProps.md#model) -- [role](IJumpStartSageMakerEndpointProps.md#role) -- [startupHealthCheckTimeoutInSeconds](IJumpStartSageMakerEndpointProps.md#startuphealthchecktimeoutinseconds) -- [vpcConfig](IJumpStartSageMakerEndpointProps.md#vpcconfig) - -## Properties - -### endpointName - -• `Optional` **endpointName**: `string` - -___ - -### environment - -• `Optional` **environment**: `Object` - -#### Index signature - -▪ [key: `string`]: `string` - -___ - -### instanceCount - -• `Optional` **instanceCount**: `number` - -___ - -### instanceType - -• `Optional` **instanceType**: [`SageMakerInstanceType`](../classes/SageMakerInstanceType.md) - -___ - -### model - -• **model**: [`JumpStartModel`](../classes/JumpStartModel.md) - -___ - -### role - -• `Optional` **role**: `Role` - -___ - -### startupHealthCheckTimeoutInSeconds - -• `Optional` **startupHealthCheckTimeoutInSeconds**: `number` - -___ - -### vpcConfig - -• `Optional` **vpcConfig**: `VpcConfigProperty` diff --git a/apidocs/interfaces/JumpStartSageMakerEndpointProps.md b/apidocs/interfaces/JumpStartSageMakerEndpointProps.md new file mode 100644 index 00000000..5fc5cc2e --- /dev/null +++ b/apidocs/interfaces/JumpStartSageMakerEndpointProps.md @@ -0,0 +1,68 @@ +[@cdklabs/generative-ai-cdk-constructs](../README.md) / JumpStartSageMakerEndpointProps + +# Interface: JumpStartSageMakerEndpointProps + +## Table of contents + +### Properties + +- [endpointName](JumpStartSageMakerEndpointProps.md#endpointname) +- [environment](JumpStartSageMakerEndpointProps.md#environment) +- [instanceCount](JumpStartSageMakerEndpointProps.md#instancecount) +- [instanceType](JumpStartSageMakerEndpointProps.md#instancetype) +- [model](JumpStartSageMakerEndpointProps.md#model) +- [role](JumpStartSageMakerEndpointProps.md#role) +- [startupHealthCheckTimeoutInSeconds](JumpStartSageMakerEndpointProps.md#startuphealthchecktimeoutinseconds) +- [vpcConfig](JumpStartSageMakerEndpointProps.md#vpcconfig) + +## Properties + +### endpointName + +• `Optional` `Readonly` **endpointName**: `string` + +___ + +### environment + +• `Optional` `Readonly` **environment**: `Object` + +#### Index signature + +▪ [key: `string`]: `string` + +___ + +### instanceCount + +• `Optional` `Readonly` **instanceCount**: `number` + +___ + +### instanceType + +• `Optional` `Readonly` **instanceType**: [`SageMakerInstanceType`](../classes/SageMakerInstanceType.md) + +___ + +### model + +• `Readonly` **model**: [`JumpStartModel`](../classes/JumpStartModel.md) + +___ + +### role + +• `Optional` `Readonly` **role**: `Role` + +___ + +### startupHealthCheckTimeoutInSeconds + +• `Optional` `Readonly` **startupHealthCheckTimeoutInSeconds**: `number` + +___ + +### vpcConfig + +• `Optional` `Readonly` **vpcConfig**: `VpcConfigProperty` diff --git a/src/patterns/gen-ai/aws-model-deployment-sagemaker/README_hugging_face.md b/src/patterns/gen-ai/aws-model-deployment-sagemaker/README_hugging_face.md index cf0dbbe1..54ee36de 100644 --- a/src/patterns/gen-ai/aws-model-deployment-sagemaker/README_hugging_face.md +++ b/src/patterns/gen-ai/aws-model-deployment-sagemaker/README_hugging_face.md @@ -68,14 +68,14 @@ new HuggingFaceSageMakerEndpoint(this, 'Mistral', { ## Initializer ``` -new HuggingFaceSageMakerEndpoint(scope: Construct, id: string, props: IHuggingFaceSageMakerEndpointProps) +new HuggingFaceSageMakerEndpoint(scope: Construct, id: string, props: HuggingFaceSageMakerEndpointProps) ``` Parameters - scope [Construct](https://docs.aws.amazon.com/cdk/api/v2/docs/constructs.Construct.html) - id string -- props IHuggingFaceSageMakerEndpointProps +- props HuggingFaceSageMakerEndpointProps ## Pattern Construct Props diff --git a/src/patterns/gen-ai/aws-model-deployment-sagemaker/README_jumpstart.md b/src/patterns/gen-ai/aws-model-deployment-sagemaker/README_jumpstart.md index e7534611..f021f828 100644 --- a/src/patterns/gen-ai/aws-model-deployment-sagemaker/README_jumpstart.md +++ b/src/patterns/gen-ai/aws-model-deployment-sagemaker/README_jumpstart.md @@ -61,14 +61,14 @@ new JumpStartSageMakerEndpoint(this, 'LLAMA2', { ## Initializer ``` -new JumpStartSageMakerEndpoint(scope: Construct, id: string, props: IJumpStartSageMakerEndpointProps) +new JumpStartSageMakerEndpoint(scope: Construct, id: string, props: JumpStartSageMakerEndpointProps) ``` Parameters - scope [Construct](https://docs.aws.amazon.com/cdk/api/v2/docs/constructs.Construct.html) - id string -- props IJumpStartSageMakerEndpointProps +- props JumpStartSageMakerEndpointProps ## Pattern Construct Props diff --git a/src/patterns/gen-ai/aws-model-deployment-sagemaker/huggingface-sagemaker-endpoint.ts b/src/patterns/gen-ai/aws-model-deployment-sagemaker/huggingface-sagemaker-endpoint.ts index d0e16827..22af7fb0 100644 --- a/src/patterns/gen-ai/aws-model-deployment-sagemaker/huggingface-sagemaker-endpoint.ts +++ b/src/patterns/gen-ai/aws-model-deployment-sagemaker/huggingface-sagemaker-endpoint.ts @@ -18,16 +18,16 @@ import { ContainerImage } from './container-image'; import { SageMakerEndpointBase } from './sagemaker-endpoint-base'; import { SageMakerInstanceType } from './sagemaker-instance-type'; -export interface IHuggingFaceSageMakerEndpointProps { - modelId: string; - container: ContainerImage; - endpointName?: string; - instanceType: SageMakerInstanceType; - instanceCount?: number; - role?: iam.Role; - environment?: { [key: string]: string }; - startupHealthCheckTimeoutInSeconds?: number; - vpcConfig?: sagemaker.CfnModel.VpcConfigProperty | undefined; +export interface HuggingFaceSageMakerEndpointProps { + readonly modelId: string; + readonly container: ContainerImage; + readonly endpointName?: string; + readonly instanceType: SageMakerInstanceType; + readonly instanceCount?: number; + readonly role?: iam.Role; + readonly environment?: { [key: string]: string }; + readonly startupHealthCheckTimeoutInSeconds?: number; + readonly vpcConfig?: sagemaker.CfnModel.VpcConfigProperty | undefined; } /** @@ -48,7 +48,7 @@ export class HuggingFaceSageMakerEndpoint extends SageMakerEndpointBase implemen private readonly startupHealthCheckTimeoutInSeconds: number; private readonly environment?: { [key: string]: string }; - constructor(scope: Construct, id: string, props: IHuggingFaceSageMakerEndpointProps) { + constructor(scope: Construct, id: string, props: HuggingFaceSageMakerEndpointProps) { super(scope, id); this.modelId = props.modelId; diff --git a/src/patterns/gen-ai/aws-model-deployment-sagemaker/jumpstart-sagemaker-endpoint.ts b/src/patterns/gen-ai/aws-model-deployment-sagemaker/jumpstart-sagemaker-endpoint.ts index 79424cdb..90e4be1b 100644 --- a/src/patterns/gen-ai/aws-model-deployment-sagemaker/jumpstart-sagemaker-endpoint.ts +++ b/src/patterns/gen-ai/aws-model-deployment-sagemaker/jumpstart-sagemaker-endpoint.ts @@ -19,15 +19,15 @@ import { JumpStartConstants } from './private/jumpstart-constants'; import { SageMakerEndpointBase } from './sagemaker-endpoint-base'; import { SageMakerInstanceType } from './sagemaker-instance-type'; -export interface IJumpStartSageMakerEndpointProps { - model: JumpStartModel; - endpointName?: string; - instanceType?: SageMakerInstanceType; - instanceCount?: number; - role?: iam.Role; - vpcConfig?: sagemaker.CfnModel.VpcConfigProperty | undefined; - environment?: { [key: string]: string }; - startupHealthCheckTimeoutInSeconds?: number; +export interface JumpStartSageMakerEndpointProps { + readonly model: JumpStartModel; + readonly endpointName?: string; + readonly instanceType?: SageMakerInstanceType; + readonly instanceCount?: number; + readonly role?: iam.Role; + readonly vpcConfig?: sagemaker.CfnModel.VpcConfigProperty | undefined; + readonly environment?: { [key: string]: string }; + readonly startupHealthCheckTimeoutInSeconds?: number; } /** @@ -50,7 +50,7 @@ export class JumpStartSageMakerEndpoint extends SageMakerEndpointBase { private readonly startupHealthCheckTimeoutInSeconds: number; private readonly environment?: { [key: string]: string }; - constructor(scope: Construct, id: string, props: IJumpStartSageMakerEndpointProps) { + constructor(scope: Construct, id: string, props: JumpStartSageMakerEndpointProps) { super(scope, id); this.model = props.model;