Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat(documentation): Update documentation and standardize #41

Merged
merged 9 commits into from
Oct 18, 2023

Conversation

krokoko
Copy link
Collaborator

@krokoko krokoko commented Oct 18, 2023

Fixes #

  • update documentation format for constructs
  • fix various typo issues
  • standardize naming for similar properties across constructs
  • make cognito user pool strongly typed for summarization
  • make merged api optional for summarization

By submitting this pull request, I confirm that you can use, modify, copy, and redistribute this contribution, under the terms of the project license.

@codecov
Copy link

codecov bot commented Oct 18, 2023

Codecov Report

All modified lines are covered by tests ✅

Files Coverage Δ
...s/gen-ai/aws-summarization-appsync-stepfn/index.ts 97.89% <100.00%> (-0.06%) ⬇️

📢 Thoughts on this report? Let us know!.

@@ -32,9 +58,57 @@ import { Construct } from 'constructs';
import { Stack, StackProps } from 'aws-cdk-lib';
import { SummarizationAppsyncStepfn, SummarizationAppsyncStepfnProps } from '@aws-samples/aws-emerging-tech-constructs';

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

import * as cognito from 'aws-cdk-lib/aws-cognito';

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

good catch, fixed in 235ae22

- [AWS Secrets Manager Pricing](https://aws.amazon.com/secrets-manager/pricing/)

> **Note**
>You can share the Amazon OpenSearch provisioned cluster between use cases, but this can drive up the number of queries per index and additional charge will apply.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

we should add the same warnings which are present in common-layer readme file for data security with external LLM.

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

for now the other constructs are using Bedrock only (cannot be changed). When those constructs will be updated to use the lambda layer, it will give the ability to the user to use any supported LLM. At that moment I will add the warning message : )


```
mutation MyMutation {
generateSummary(summaryInput:{files:[{name: "document1.txt", status: ""}], summary_job_id:"81"}) {
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Did you updated the summary document reader lambda to support input file with txt format. don't see lambda change in this PR. The current input validator lambda expect pdf file and then the document reader lambda update the file format to txt based on isFileTransformationRequired flag.

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

next PR I will fix it for both qa and summarization

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Very detailed documentation. really liked it.

@krokoko krokoko merged commit 2926b97 into main Oct 18, 2023
8 checks passed
@krokoko krokoko deleted the doc/doc_update_cstrcts branch October 18, 2023 23:28
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants