feat: combine all

feat: combining all

parent 364274d
author github-actions <github-actions@github.com> 1702080482 +0000
committer Patrick <ocopatr@amazon.com> 1705428058 -0800

chore(deps): upgrade dependencies

Upgrades project dependencies. See details in [workflow run].

[Workflow Run]: https://github.com/awslabs/generative-ai-cdk-constructs/actions/runs/7147565079

------

*Automatically created by projen via the "upgrade-main" workflow*

Signed-off-by: github-actions <github-actions@github.com>

chore(deps): upgrade dependencies

Upgrades project dependencies. See details in [workflow run].

[Workflow Run]: https://github.com/awslabs/generative-ai-cdk-constructs/actions/runs/7161144540

------

*Automatically created by projen via the "upgrade-main" workflow*

Signed-off-by: github-actions <github-actions@github.com>

chore(doc): update documentation and generate new list of models to deploy

chore(deps): upgrade dependencies

Upgrades project dependencies. See details in [workflow run].

[Workflow Run]: https://github.com/awslabs/generative-ai-cdk-constructs/actions/runs/7174960686

------

*Automatically created by projen via the "upgrade-main" workflow*

Signed-off-by: github-actions <github-actions@github.com>

feat: qa concurrency props

fix(constructs): fix log group name

fix(lint): run linter

fix(lint): differentiate name

feat(doc): update readme with additional resources

chore(deps): upgrade dependencies

Upgrades project dependencies. See details in [workflow run].

[Workflow Run]: https://github.com/awslabs/generative-ai-cdk-constructs/actions/runs/7228300421

------

*Automatically created by projen via the "upgrade-main" workflow*

Signed-off-by: github-actions <github-actions@github.com>

chore(deps): upgrade dependencies

Upgrades project dependencies. See details in [workflow run].

[Workflow Run]: https://github.com/awslabs/generative-ai-cdk-constructs/actions/runs/7255404764

------

*Automatically created by projen via the "upgrade-main" workflow*

Signed-off-by: github-actions <github-actions@github.com>

chore(deps): upgrade dependencies

Upgrades project dependencies. See details in [workflow run].

[Workflow Run]: https://github.com/awslabs/generative-ai-cdk-constructs/actions/runs/7325128447

------

*Automatically created by projen via the "upgrade-main" workflow*

Signed-off-by: github-actions <github-actions@github.com>

chore: upgrading package versions

Docs no longer support langchain 0.0.329

Signed-off-by: Patrick O'Connor <35761519+oconpa@users.noreply.github.com>

fix(config): update .projenrc.ts

Add IDE specific ignore folders

Signed-off-by: Michael Walker <michaelhuytran@gmail.com>

feat(configs): add gitignore for IDE files

ci(projen): uncapping cdk version to allow usage with latest cdk less pip error

ci(projen): lowest build version

feat(layer): additional packages prop, rename of layers for ease, typing from layer construct

fix: remove console log statements

Signed-off-by: Scott Schreckengaust <scottschreckengaust@users.noreply.github.com>

feat(constructs): add how to section for testing constructs

feat(docs): add screenshots

fix(readme): update README.md

Co-authored-by: Scott Schreckengaust <scottschreckengaust@users.noreply.github.com>
Signed-off-by: Michael Walker <michaelhuytran@gmail.com>

fix(readme): update README.md

Co-authored-by: Scott Schreckengaust <scottschreckengaust@users.noreply.github.com>
Signed-off-by: Michael Walker <michaelhuytran@gmail.com>

fix(readme): update README.md

Co-authored-by: Scott Schreckengaust <scottschreckengaust@users.noreply.github.com>
Signed-off-by: Michael Walker <michaelhuytran@gmail.com>

feat(docs): move to developer guide

feat(docs): move to developer guide

fix: ts-jest configuration under globals

Projen 0.78.9 fixes the warning:

> (WARN) Define `ts-jest` config under `globals` is deprecated

Signed-off-by: Scott Schreckengaust <scottschreckengaust@users.noreply.github.com>

fix: correct opt-out logic (awslabs#183)

fix: correct opt-out logic

* dynamically fetch version from the package.json
* include the name of the class
* string format
* camel case solution_id variable and move into context

---------

Signed-off-by: Scott Schreckengaust <scottschreckengaust@users.noreply.github.com>

feat(construct): new construct for deployment of custom models to sagemaker (awslabs#180)

* feat(construct): New construct CustomSagemakerEndpoint Fixes (New construct): Add support to deploy custom models to a sagemaker endpoint awslabs#150
* chore(construct): Update documentation
* feat(construct): Add new projen task to run the code generation step (create list of available containers / jumpstart models). Can be used through projen generate-models-containers
* chore(construct): Update list of available models
* fix(construct): Fixes (gen-ai): JumpStartSageMakerEndpoint not working awslabs#179 : address the issue of some models from JumpStart which can't be deployed. This is due to the construct requiring model data to be provided as a compressed object, however some newer JumpStart models provide uncompressed model artifacts. Tested the fix with the reported model - whisper base 2.0.0. Deployed model and ran inference. This requires an upgrade of cdk as the update to the L1 CloudFormation resource was added recently (addition of the property https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_sagemaker.CfnModel.ModelDataSourceProperty.html)

chore(deps): upgrade dependencies (awslabs#188)

Upgrades project dependencies. See details in [workflow run].

[Workflow Run]: https://github.com/awslabs/generative-ai-cdk-constructs/actions/runs/7482301025

------

*Automatically created by projen via the "upgrade-main" workflow*

Signed-off-by: github-actions <github-actions@github.com>
Co-authored-by: github-actions <github-actions@github.com>

fix: use definition instead of schema (awslabs#187)

Closes awslabs#186

Signed-off-by: Scott Schreckengaust <scottschreckengaust@users.noreply.github.com>

feat: add husky with a convential commit check (awslabs#189)

Signed-off-by: Scott Schreckengaust <scottschreckengaust@users.noreply.github.com>

fix(doc): Update README.md (awslabs#190)

Remove duplicated section from the readme

Signed-off-by: Alain Krok <alkrok@amazon.com>

fix: do not require husky downstream (awslabs#192)

Signed-off-by: Scott Schreckengaust <scottschreckengaust@users.noreply.github.com>

chore(doc): Update README_custom_sagemaker_endpoint.md (awslabs#191)

Fix image not displayed

Signed-off-by: Alain Krok <alkrok@amazon.com>

chore(deps): upgrade dependencies (awslabs#194)

Upgrades project dependencies. See details in [workflow run].

[Workflow Run]: https://github.com/awslabs/generative-ai-cdk-constructs/actions/runs/7508788235

------

*Automatically created by projen via the "upgrade-main" workflow*

Signed-off-by: github-actions <github-actions@github.com>
Co-authored-by: github-actions <github-actions@github.com>

Author: github-actions

.eslintrc.json

@@ -0,0 +1,4 @@
+#!/usr/bin/env sh
+. "$(dirname -- "$0")/_/husky.sh"
+
+npx --no -- commitlint --edit "$1"

.gitattributes

@@ -10,7 +10,8 @@
  *  OR CONDITIONS OF ANY KIND, express or implied. See the License for the specific language governing permissions
  *  and limitations under the License.
  */
-import { awscdk } from 'projen';
+import { ProjenStruct, Struct } from '@mrgrain/jsii-struct-builder';
+import { JsonPatch, awscdk } from 'projen';
 import { NpmAccess } from 'projen/lib/javascript';
 import {
   buildMeritBadgerWorkflow,
@@ -27,26 +28,32 @@ import {
 const GITHUB_USER = 'awslabs';
 const PUBLICATION_NAMESPACE = 'cdklabs';
 const PROJECT_NAME = 'generative-ai-cdk-constructs';
-const CDK_VERSION: string = '2.111.0';
+const CDK_VERSION: string = '2.114.0';
 
 const project = new awscdk.AwsCdkConstructLibrary({
   author: 'Amazon Web Services - Prototyping and Cloud Engineering',
   authorAddress: 'https://aws.amazon.com',
   authorOrganization: true,
   description: 'AWS Generative AI CDK Constructs is a library for well-architected generative AI patterns.',
   cdkVersion: CDK_VERSION,
-  projenVersion: '~0.77.4',
+  projenVersion: '~0.78.8',
   constructsVersion: '10.3.0',
-  cdkVersionPinning: true,
   defaultReleaseBranch: 'main',
-  jsiiVersion: '~5.0.0',
+  jsiiVersion: '~5.3.0',
   name: '@' + PUBLICATION_NAMESPACE + '/' + PROJECT_NAME,
   projenrcTs: true,
   repositoryUrl: 'https://github.com/' + GITHUB_USER + '/' + PROJECT_NAME,
 
   // description: undefined,  /* The description is just a string that helps people understand the purpose of the package. */
   keywords: ['constructs', 'aws-cdk', 'generative-ai', 'emerging-tech'],
-  devDeps: ['eslint-plugin-header'],
+  devDeps: [
+    '@commitlint/config-conventional',
+    'commitlint',
+    'eslint-plugin-header',
+    'husky',
+    'pinst',
+    '@mrgrain/jsii-struct-builder',
+  ],
   deps: ['cdk-nag'],
 
   // Keep synchronized with https://github.com/nodejs/release#release-schedule
@@ -85,7 +92,15 @@ const project = new awscdk.AwsCdkConstructLibrary({
   license: 'Apache-2.0',
   copyrightPeriod: '2023-',
   copyrightOwner: 'Amazon.com, Inc. or its affiliates. All Rights Reserved.',
-  gitignore: ['*.DS_STORE', '!.node-version', '*.pyc', '__pycache__/', '!.ort.yml'],
+  gitignore: [
+    '*.DS_STORE',
+    '!.node-version',
+    '*.pyc',
+    '__pycache__/',
+    '!.ort.yml',
+    '.idea',
+    '.vscode',
+  ],
   stability: 'experimental',
   sampleCode: false,
   stale: true,
@@ -143,6 +158,36 @@ project.eslint?.addPlugins('header');
 project.eslint?.addRules({
   'header/header': [2, 'header.js'],
 });
+project.eslint?.addIgnorePattern('LangchainProps.ts');
+project.eslint?.addIgnorePattern('AdapterProps.ts');
 
+// Shared interfaces extending pre-existing CDK interfaces
+new ProjenStruct(project, { name: 'LangchainProps' })
+  .mixin(Struct.fromFqn('aws-cdk-lib.aws_lambda.LayerVersionProps'))
+  .withoutDeprecated()
+  .omit('code', 'compatibleRuntimes', 'compatibleArchitectures', 'description');
 
-project.synth();
+new ProjenStruct(project, { name: 'AdapterProps' })
+  .mixin(Struct.fromFqn('aws-cdk-lib.aws_lambda.LayerVersionProps'))
+  .withoutDeprecated()
+  .omit('code', 'description');
+
+const packageJson = project.tryFindObjectFile('package.json');
+packageJson?.patch(JsonPatch.add('/scripts/prepare', 'husky install')); // yarn 1
+packageJson?.patch(JsonPatch.add('/scripts/postinstall', 'husky install')); // yarn 2
+packageJson?.patch(JsonPatch.add('/scripts/prepack', 'pinst --disable'));
+packageJson?.patch(JsonPatch.add('/scripts/postpack', 'pinst --enable'));
+
+// Add generation of new available models for constructs
+project.addTask('generate-models-containers', {
+  description: 'Generate new list of models available from Jumpstart and DLC containers',
+  steps: [
+    {
+      say: 'Generate new list of models available from Jumpstart and DLC containers',
+      cwd: project.srcdir+'/patterns/gen-ai/aws-model-deployment-sagemaker/code-generation',
+      exec: 'npm run generate',
+    },
+  ],
+});
+
+project.synth();

.gitignore

@@ -1,3 +1,7 @@
+# CDK Generative AI Constructs V0.1.21 (2024-01-11)
+
+Based on CDK library version 2.114.0
+
 # CDK Generative AI Constructs V0.1.0 (2023-11-30)
 
 Based on CDK library version 2.111.0

.husky/commit-msg

@@ -16,9 +16,9 @@ Default output format [None]: json
 ```
 
 - [Node](https://nodejs.org/en) >= v20.9.0
-- [AWS CDK](https://github.com/aws/aws-cdk/releases/tag/v2.102.0) >= 2.111.0
+- [AWS CDK](https://github.com/aws/aws-cdk/releases/tag/v2.102.0) >= 2.114.0
 - [Python](https://www.python.org/downloads/) >=3.9
-- [Projen](https://github.com/projen/projen) >= 0.77.4
+- [Projen](https://github.com/projen/projen) >= 0.78.8
 - [Yarn](https://classic.yarnpkg.com/lang/en/docs/cli/install/) >= 1.22.19
 
 You can use the command below to install the dependencies listed above
@@ -64,6 +64,63 @@ All test files can be found in the /test directory under each construct (or core
 | `npx projen test` | This will run all tests (unit+integration) |
 
 ---
+## Testing Your Construct Locally
+
+- Using the samples repository to test your locally changed constructs. This is also useful for development.
+
+### Pre-req:
+- Download the samples repository (The official samples repository https://github.com/aws-samples/generative-ai-cdk-constructs-samples includes a collection of functional use case implementations to demonstrate the usage of AWS Generative AI CDK Constructs. These can be used in the same way as architectural patterns, and can be conceptualized as an additional "higher-level" abstraction of those patterns. Those patterns (constructs) are composed together into [stacks](https://docs.aws.amazon.com/cdk/latest/guide/stacks.html), forming a "CDK app".
+)
+
+
+### Step 1: Building the Generative AI CDK Construct
+
+Navigate to the [Generative AI CDK Construct Repository] (https://github.com/aws-samples/generative-ai-cdk-constructs-samples):
+    Open your command line interface and change directory to the generative AI CDK construct repository.
+
+- Execute the command ```yarn build```. 
+  - This command runs npx projen build and generates a .jsii file in your repository.
+
+### Step 2: Packaging the Constructs
+1. Run Yarn Package:JS:
+    - Execute ```yarn package:js```.
+      - This command creates a new .tgz package of all constructs in the dist/js folder.
+
+2. Locate the TGZ File:
+    - Find the generated .tgz file, typically named something like dist/js/generative-ai-cdk-constructs-0.0.0.jsii.tgz.
+
+
+### Step 3: Integrating with Sample Application
+
+1. Drag and Drop the TGZ File:
+    - Drag and drop the .tgz file into your samples repository, ideally at the root like "samples/document_explorer".
+
+2. Modify package.json in Sample Repo:
+    - Open package.json in your samples repository.
+    - Under dependencies, locate the entry for "@cdklabs/generative-ai-cdk-constructs".
+    - Replace the existing entry with file:<path-to-tgz-file>. For example: 
+    ```
+...
+  "dependencies": {
+    "@cdklabs/generative-ai-cdk-constructs": "file:generative-ai-cdk-constructs@0.0.0.jsii.tgz",
+...
+    ```
+
+### Step 4: Deploying to AWS
+
+1. Navigate to Sample Repo Directory:
+  - Change directory to your samples repository.
+2. AWS CDK Deployment:
+  - Ensure you are authenticated to AWS with the necessary permissions.
+  - Run ```cdk deploy``` to deploy the new backend with your generative AI constructs into the AWS Cloud.
+3. Verify Deployment:
+  - Log into your AWS console and verify that the resources have been deployed successfully.
+  - Check for any errors in the AWS CloudFormation console and address them as necessary.
+
+### Testing and Verification
+
+- After deployment, you may want to test the functionalities of the generative AI constructs in the AWS environment.
+- Ensure all integrations and functionalities are working as expected.
 
 ## Project structure
 

.npmignore

@@ -22,6 +22,7 @@
 - [Getting Started](#getting-started)
 - [Catalog](#catalog)
 - [Sample Use Cases](#sample-use-cases)
+- [Additional Resources](#additional-resources)
 - [Operational Metrics Collection](#operational-metrics-collection)
 - [Roadmap](#roadmap)
 - [Legal Disclaimer](#legal-disclaimer)
@@ -74,15 +75,20 @@ The following constructs are available in the library:
 | [Question answering](./src/patterns/gen-ai/aws-qa-appsync-opensearch/) | Question answering with a large language model (Anthropic Claude V2) using a RAG (retrieval augmented generation) source and/or long context. | Amazon OpenSearch, AWS Lambda, Amazon Bedrock, AWS AppSync | 
 | [Summarization](./src/patterns/gen-ai/aws-summarization-appsync-stepfn/) | Document summarization with a large language model (Anthropic Claude V2). | AWS Lambda, Amazon Bedrock, AWS AppSync and Amazon Elasticache for Redis.  |
 | [Lambda layer](./src/patterns/gen-ai/aws-langchain-common-layer/) | Python Lambda layer providing dependencies and utilities to develop generative AI applications on AWS. | AWS Lambda, Amazon Bedrock, Amazon SageMaker | 
-| [SageMaker model deployment](./src/patterns/gen-ai/aws-model-deployment-sagemaker/) | Deploy a foundation model from Amazon SageMaker JumpStart or Hugging Face to an Amazon SageMaker endpoint. | Amazon SageMaker | 
+| [SageMaker model deployment (Jumpstart)](./src/patterns/gen-ai/aws-model-deployment-sagemaker/README_jumpstart.md) | Deploy a foundation model from Amazon SageMaker JumpStart to an Amazon SageMaker endpoint. | Amazon SageMaker | 
+| [SageMaker model deployment (Hugging Face)](./src/patterns/gen-ai/aws-model-deployment-sagemaker/README_hugging_face.md) | Deploy a foundation model from Hugging Face to an Amazon SageMaker endpoint. | Amazon SageMaker | 
+| [SageMaker model deployment (Custom)](./src/patterns/gen-ai/aws-model-deployment-sagemaker/README_custom_sagemaker_endpoint.md) | Deploy a foundation model from an S3 location to an Amazon SageMaker endpoint. | Amazon SageMaker | 
 
 # Sample Use Cases
 
-This library includes a collection of functional use case implementations to demonstrate the usage of AWS Generative AI CDK Constructs. These can be used in the same way as architectural patterns, and can be conceptualized as an additional "higher-level" abstraction of those patterns. Those patterns (constructs) are composed together into [stacks](https://docs.aws.amazon.com/cdk/latest/guide/stacks.html), forming a "CDK app".
+The official samples repository https://github.com/aws-samples/generative-ai-cdk-constructs-samples includes a collection of functional use case implementations to demonstrate the usage of AWS Generative AI CDK Constructs. These can be used in the same way as architectural patterns, and can be conceptualized as an additional "higher-level" abstraction of those patterns. Those patterns (constructs) are composed together into [stacks](https://docs.aws.amazon.com/cdk/latest/guide/stacks.html), forming a "CDK app".
 
-The following use cases are provided as functional examples:
+# Additional Resources
 
-Coming soon
+| Resource |Description|
+|:-------------|:-------------|
+| [AWS re:Invent 2023 - Keynote with Dr. Werner Vogels](https://youtu.be/UTRBVPvzt9w?t=6252) | Dr. Werner Vogels, Amazon.com's VP and CTO, announces the AWS Generative AI CDK Constructs during his AWS re:Invent 2023 keynote. |
+| [aws-cdk-stack-builder-tool](https://github.com/aws-samples/aws-cdk-stack-builder-tool) | AWS CDK Builder is a browser-based tool designed to streamline bootstrapping of Infrastructure as Code (IaC) projects using the AWS Cloud Development Kit (CDK). |
 
 # Operational Metrics Collection
 

.projen/deps.json

@@ -1,7 +1,7 @@
-boto3>=1.28.69
-botocore>=1.31.69
+boto3>=1.34.6
+botocore>=1.34.6
 requests==2.31.0
 requests-aws4auth==1.2.3
-langchain==0.0.329
-opensearch-py==2.3.1
-openai==0.28.1
+langchain==0.0.351
+opensearch-py==2.4.2
+openai==1.6.0