기계 번역으로 제공되는 번역입니다. 제공된 번역과 원본 영어의 내용이 상충하는 경우에는 영어 버전이 우선합니다.
# CloudFormation 템플릿
다운로드하는 `cloudformation-mortgage-flow-setup.zip` 파일에는 다음 파일이 포함됩니다.
+ `deploy.sh` - 리소스를 배포하고 사용할 기본 CloudFormation 템플릿을 준비하는 쉘 스크립트.
+ `artifacts` - 에이전트 및 지식 기반 템플릿에 대한 함수가 있는 .zip 파일이 포함된 폴더:
+ 에이전트의 작업 그룹에 대한 Lambda 함수
+ `agent_loan_calculator.zip`
+ `mls_lookup.zip`
+ `loader_deployment_package.zip`
+ 지식 기반을 설정하기 위한 함수
+ `custom-resource-lambda.zip`
+ `opensearchpy-layer.zip`
+ `provider-event-handler.zip`
+ `api-schema` - 작업 그룹에 대한 API 스키마가 포함된 폴더.
+ `knowledge-base-data-source` - [Fannie Mae의 판매 안내서](https://selling-guide.fanniemae.com/) PDF가 포함된 폴더.
+ `templates` - 이 흐름의 리소스를 위한 템플릿(JSON 및 YAML 두 형식으로 제공)이 포함된 폴더.
+ `main-stack-tmp` - 나머지 템플릿을 중첩 스택으로 배포하는 기본 템플릿. 이 파일은 배포 스크립트가 실행된 후 `main-stack`으로 전환됩니다.
+ `guardrails-template` - 에이전트와 연결할 가드레일의 템플릿.
+ `prompts-template` - 흐름에 사용할 프롬프트의 템플릿.
+ `kb-role-template` - OpenSearch 템플릿과 지식 기반 템플릿 모두에서 사용할 지식 기반 역할의 템플릿.
+ `oss-infra-template` - 지식 기반에 사용할 Amazon OpenSearch Serverless 벡터 스토어의 템플릿.
+ `kb-infra-template` - 에이전트와 연결할 모기지 대출 지식 기반의 템플릿.
+ `agent-template` - 흐름에 사용할 모기지 처리 에이전트의 템플릿.
+ `mortgage-flow-template` - 모든 리소스를 결합하는 모기지 처리 흐름의 템플릿.
+ `README.md` - 템플릿 사용 단계를 설명하는 README 파일.
다음 주제에서는 각 스택에 사용되는 CloudFormation 템플릿을 보여줍니다. 기본 스택은 나머지 스택을 [중첩 스택](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-nested-stacks.html)으로 배포합니다.
**Topics**
+ [기본 스택](#getting-started-mortgage-templates-main)
+ [Amazon Bedrock Guardrails 스택](#getting-started-mortgage-guardrail-templates)
+ [Amazon Bedrock Prompt Management 스택](#getting-started-mortgage-prompts-templates)
+ [Amazon Bedrock Knowledge Bases 스택](#getting-started-mortgage-kb-templates)
## 기본 스택
기본 스택은 템플릿을 업로드할 때 정의할 수 있는 파라미터를 정의합니다. 이러한 값은 나머지 중첩 스택 각각에 전달됩니다. 배포 스크립트는 `Q01pS3BucketName` 파라미터의 기본값에 대한 *MortgageFlowBucket*을 스크립트에서 배포한 리소스가 포함된 실제 S3 버킷으로 바꿉니다.
------
#### [ YAML ]
```
AWSTemplateFormatVersion: '2010-09-09'
Description: "[AWSDocs] AmazonBedrockDocs: getting-started-mortgage-flow"
Parameters:
Q01pS3BucketName:
Type: String
Description: Provide existing S3 bucket name where data is already stored
Default: MortgageFlowBucket
Q02pFlowName:
Type: String
Description: Name for the flow
Default: MortgageFlow
Q03pGuardrailName:
Type: String
Description: Name for guardrail to attach to agent
Default: MortgageGR
Q04pKnowledgeBaseName:
Type: String
Description: Name for knowledge base to associate with agent
Default: MortgageKB
Q05pAgentName:
Type: String
Description: Name for agent to create
Default: MortgageAgent
Q06pKBEmbedModel:
Type: String
Description: Select Embedding model
Default: amazon.titan-embed-text-v1
Q07pKBChunkingStrategy:
Type: String
Description: Select Chunking strategy
AllowedValues:
- Default chunking
- Fixed-size chunking
- No chunking
Default: Default chunking
Q08pKBMaxTokens:
Type: Number
Description: Maximum number of tokens in a chunk
Default: 300
Q09pKBOverlapPercentage:
Type: Number
Description: Percent overlap in each chunk
Default: 20
Q10pKBVectorStore:
Type: String
Description: Select vector store
AllowedValues:
- Open-Search-Serverless
Default: Open-Search-Serverless
Q11pOSSCollectionName:
Type: String
Description: Name of the Collection
MinLength: 1
MaxLength: 63
Default: mortgage-kb-collection
AllowedPattern: ^[a-z0-9](-*[a-z0-9])*
ConstraintDescription: Must be lowercase or numbers with a length of 1-32 characters
Q12pOSSIndexName:
Type: String
Description: Index name to be created in vector store
MinLength: 1
MaxLength: 63
Default: mortgage-kb-index
AllowedPattern: ^[a-z0-9](-*[a-z0-9])*
ConstraintDescription: Must be lowercase or numbers with a length of 1-63 characters
# Q13pVectorFieldName:
# Type: String
# Description: Vector field name
# Default: bedrock-knowledge-base-default-vector
# Q14pMetaDataFieldName:
# Type: String
# Description: Metadata field name
# Default: AMAZON_BEDROCK_METADATA
# Q15pTextFieldName:
# Type: String
# Description: Text field name
# Default: AMAZON_BEDROCK_TEXT_CHUNK
Resources:
KBRoleStack:
Type: AWS::CloudFormation::Stack
Properties:
TemplateURL: !Sub https://${Q01pS3BucketName}.s3.amazonaws.com/templates/yaml/kb-role-template.yaml
TimeoutInMinutes: 15
Parameters:
Q01pS3BucketName:
Ref: Q01pS3BucketName
OSSStack:
Type: AWS::CloudFormation::Stack
DependsOn: KBRoleStack
Properties:
TemplateURL: !Sub https://${Q01pS3BucketName}.s3.amazonaws.com/templates/yaml/oss-infra-template.yaml
TimeoutInMinutes: 15
Parameters:
Q01pS3BucketName:
Ref: Q01pS3BucketName
Q06pKBEmbedModel:
Ref: Q06pKBEmbedModel
Q11pOSSCollectionName:
Ref: Q11pOSSCollectionName
Q12pOSSIndexName:
Ref: Q12pOSSIndexName
pKBRole:
Fn::GetAtt:
- KBRoleStack
- Outputs.KBRole
pKBRoleArn:
Fn::GetAtt:
- KBRoleStack
- Outputs.KBRoleArn
KBStack:
Type: AWS::CloudFormation::Stack
DependsOn: OSSStack
Properties:
TemplateURL: !Sub https://${Q01pS3BucketName}.s3.amazonaws.com/templates/yaml/kb-infra-template.yaml
TimeoutInMinutes: 15
Parameters:
KnowledgeBaseName:
Ref: Q04pKnowledgeBaseName
Q01pS3BucketName:
Ref: Q01pS3BucketName
Q06pKBEmbedModel:
Ref: Q06pKBEmbedModel
Q07pKBChunkingStrategy:
Ref: Q07pKBChunkingStrategy
Q08pKBMaxTokens:
Ref: Q08pKBMaxTokens
Q09pKBOverlapPercentage:
Ref: Q09pKBOverlapPercentage
Q11pOSSCollectionName:
Ref: Q11pOSSCollectionName
Q12pOSSIndexName:
Ref: Q12pOSSIndexName
# Q13pVectorFieldName:
# Ref: Q13pVectorFieldName
# Q14pMetaDataFieldName:
# Ref: Q14pMetaDataFieldName
# Q15pTextFieldName:
# Ref: Q15pTextFieldName
pCollectionArn:
Fn::GetAtt:
- OSSStack
- Outputs.CollectionArn
pKBRoleArn:
Fn::GetAtt:
- KBRoleStack
- Outputs.KBRoleArn
pKBRole:
Fn::GetAtt:
- KBRoleStack
- Outputs.KBRole
GRStack:
Type: AWS::CloudFormation::Stack
Properties:
TemplateURL: !Sub https://${Q01pS3BucketName}.s3.amazonaws.com/templates/yaml/guardrails-template.yaml
TimeoutInMinutes: 15
Parameters:
GuardrailName:
Ref: Q03pGuardrailName
AgentStack:
Type: AWS::CloudFormation::Stack
DependsOn:
- KBStack
- GRStack
Properties:
TemplateURL: !Sub https://${Q01pS3BucketName}.s3.amazonaws.com/templates/yaml/agent-template.yaml
TimeoutInMinutes: 15
Parameters:
Q01pS3BucketName:
Ref: Q01pS3BucketName
KnowledgeBaseId:
Fn::GetAtt:
- KBStack
- Outputs.KBId
GuardrailArn:
Fn::GetAtt:
- GRStack
- Outputs.GuardrailArn
GuardrailVersion:
Fn::GetAtt:
- GRStack
- Outputs.GuardrailVersion
PromptsStack:
Type: AWS::CloudFormation::Stack
Properties:
TemplateURL: !Sub https://${Q01pS3BucketName}.s3.amazonaws.com/templates/yaml/prompts-template.yaml
TimeoutInMinutes: 15
FlowStack:
Type: AWS::CloudFormation::Stack
DependsOn:
- AgentStack
- PromptsStack
Properties:
TemplateURL: !Sub https://${Q01pS3BucketName}.s3.amazonaws.com/templates/yaml/mortgage-flow-template.yaml
TimeoutInMinutes: 15
Parameters:
FlowName:
Ref: Q02pFlowName
Q01pS3BucketName:
Ref: Q01pS3BucketName
ProcessApplicationPromptArn:
Fn::GetAtt:
- PromptsStack
- Outputs.ProcessApplicationPromptArn
RejectionPromptArn:
Fn::GetAtt:
- PromptsStack
- Outputs.RejectionPromptArn
AgentId:
Fn::GetAtt:
- AgentStack
- Outputs.AgentId
```
------
#### [ JSON ]
```
{
"AWSTemplateFormatVersion": "2010-09-09",
"Description": "[AWSDocs] AmazonBedrockDocs: getting-started-mortgage-flow",
"Parameters": {
"Q01pS3BucketName": {
"Type": "String",
"Description": "Provide existing S3 bucket name where data is already stored",
"Default": "MortgageFlowBucket"
},
"Q02pFlowName": {
"Type": "String",
"Description": "Name for the flow",
"Default": "MortgageFlow"
},
"Q03pGuardrailName": {
"Type": "String",
"Description": "Name for guardrail to attach to agent",
"Default": "MortgageGR"
},
"Q04pKnowledgeBaseName": {
"Type": "String",
"Description": "Name for knowledge base to associate with agent",
"Default": "MortgageKB"
},
"Q05pAgentName": {
"Type": "String",
"Description": "Name for agent to create",
"Default": "MortgageAgent"
},
"Q06pKBEmbedModel": {
"Type": "String",
"Description": "Select Embedding model",
"Default": "amazon.titan-embed-text-v1"
},
"Q07pKBChunkingStrategy": {
"Type": "String",
"Description": "Select Chunking strategy",
"AllowedValues": [
"Default chunking",
"Fixed-size chunking",
"No chunking"
],
"Default": "Default chunking"
},
"Q08pKBMaxTokens": {
"Type": "Number",
"Description": "Maximum number of tokens in a chunk",
"Default": 300
},
"Q09pKBOverlapPercentage": {
"Type": "Number",
"Description": "Percent overlap in each chunk",
"Default": 20
},
"Q10pKBVectorStore": {
"Type": "String",
"Description": "Select vector store",
"AllowedValues": [
"Open-Search-Serverless"
],
"Default": "Open-Search-Serverless"
},
"Q11pOSSCollectionName": {
"Type": "String",
"Description": "Name of the Collection",
"MinLength": 1,
"MaxLength": 63,
"Default": "mortgage-kb-collection",
"AllowedPattern": "^[a-z0-9](-*[a-z0-9])*",
"ConstraintDescription": "Must be lowercase or numbers with a length of 1-32 characters"
},
"Q12pOSSIndexName": {
"Type": "String",
"Description": "Index name to be created in vector store",
"MinLength": 1,
"MaxLength": 63,
"Default": "mortgage-kb-index",
"AllowedPattern": "^[a-z0-9](-*[a-z0-9])*",
"ConstraintDescription": "Must be lowercase or numbers with a length of 1-63 characters"
}
},
"Resources": {
"KBRoleStack": {
"Type": "AWS::CloudFormation::Stack",
"Properties": {
"TemplateURL": {
"Fn::Sub": "https://${Q01pS3BucketName}.s3.amazonaws.com/templates/json/kb-role-template.json"
},
"TimeoutInMinutes": 15,
"Parameters": {
"Q01pS3BucketName": {
"Ref": "Q01pS3BucketName"
}
}
}
},
"OSSStack": {
"Type": "AWS::CloudFormation::Stack",
"DependsOn": "KBRoleStack",
"Properties": {
"TemplateURL": {
"Fn::Sub": "https://${Q01pS3BucketName}.s3.amazonaws.com/templates/json/oss-infra-template.json"
},
"TimeoutInMinutes": 15,
"Parameters": {
"Q01pS3BucketName": {
"Ref": "Q01pS3BucketName"
},
"Q06pKBEmbedModel": {
"Ref": "Q06pKBEmbedModel"
},
"Q11pOSSCollectionName": {
"Ref": "Q11pOSSCollectionName"
},
"Q12pOSSIndexName": {
"Ref": "Q12pOSSIndexName"
},
"pKBRole": {
"Fn::GetAtt": [
"KBRoleStack",
"Outputs.KBRole"
]
},
"pKBRoleArn": {
"Fn::GetAtt": [
"KBRoleStack",
"Outputs.KBRoleArn"
]
}
}
}
},
"KBStack": {
"Type": "AWS::CloudFormation::Stack",
"DependsOn": "OSSStack",
"Properties": {
"TemplateURL": {
"Fn::Sub": "https://${Q01pS3BucketName}.s3.amazonaws.com/templates/json/kb-infra-template.json"
},
"TimeoutInMinutes": 15,
"Parameters": {
"KnowledgeBaseName": {
"Ref": "Q04pKnowledgeBaseName"
},
"Q01pS3BucketName": {
"Ref": "Q01pS3BucketName"
},
"Q06pKBEmbedModel": {
"Ref": "Q06pKBEmbedModel"
},
"Q07pKBChunkingStrategy": {
"Ref": "Q07pKBChunkingStrategy"
},
"Q08pKBMaxTokens": {
"Ref": "Q08pKBMaxTokens"
},
"Q09pKBOverlapPercentage": {
"Ref": "Q09pKBOverlapPercentage"
},
"Q11pOSSCollectionName": {
"Ref": "Q11pOSSCollectionName"
},
"Q12pOSSIndexName": {
"Ref": "Q12pOSSIndexName"
},
"pCollectionArn": {
"Fn::GetAtt": [
"OSSStack",
"Outputs.CollectionArn"
]
},
"pKBRoleArn": {
"Fn::GetAtt": [
"KBRoleStack",
"Outputs.KBRoleArn"
]
},
"pKBRole": {
"Fn::GetAtt": [
"KBRoleStack",
"Outputs.KBRole"
]
}
}
}
},
"GRStack": {
"Type": "AWS::CloudFormation::Stack",
"Properties": {
"TemplateURL": {
"Fn::Sub": "https://${Q01pS3BucketName}.s3.amazonaws.com/templates/json/guardrails-template.json"
},
"TimeoutInMinutes": 15,
"Parameters": {
"GuardrailName": {
"Ref": "Q03pGuardrailName"
}
}
}
},
"AgentStack": {
"Type": "AWS::CloudFormation::Stack",
"DependsOn": [
"KBStack",
"GRStack"
],
"Properties": {
"TemplateURL": {
"Fn::Sub": "https://${Q01pS3BucketName}.s3.amazonaws.com/templates/json/agent-template.json"
},
"TimeoutInMinutes": 15,
"Parameters": {
"Q01pS3BucketName": {
"Ref": "Q01pS3BucketName"
},
"KnowledgeBaseId": {
"Fn::GetAtt": [
"KBStack",
"Outputs.KBId"
]
},
"GuardrailArn": {
"Fn::GetAtt": [
"GRStack",
"Outputs.GuardrailArn"
]
},
"GuardrailVersion": {
"Fn::GetAtt": [
"GRStack",
"Outputs.GuardrailVersion"
]
}
}
}
},
"PromptsStack": {
"Type": "AWS::CloudFormation::Stack",
"Properties": {
"TemplateURL": {
"Fn::Sub": "https://${Q01pS3BucketName}.s3.amazonaws.com/templates/json/prompts-template.json"
},
"TimeoutInMinutes": 15
}
},
"FlowStack": {
"Type": "AWS::CloudFormation::Stack",
"DependsOn": [
"AgentStack",
"PromptsStack"
],
"Properties": {
"TemplateURL": {
"Fn::Sub": "https://${Q01pS3BucketName}.s3.amazonaws.com/templates/json/mortgage-flow-template.json"
},
"TimeoutInMinutes": 15,
"Parameters": {
"FlowName": {
"Ref": "Q02pFlowName"
},
"Q01pS3BucketName": {
"Ref": "Q01pS3BucketName"
},
"ProcessApplicationPromptArn": {
"Fn::GetAtt": [
"PromptsStack",
"Outputs.ProcessApplicationPromptArn"
]
},
"RejectionPromptArn": {
"Fn::GetAtt": [
"PromptsStack",
"Outputs.RejectionPromptArn"
]
},
"AgentId": {
"Fn::GetAtt": [
"AgentStack",
"Outputs.AgentId"
]
}
}
}
}
}
}
```
------
## Amazon Bedrock Guardrails 스택
이 스택은 다음과 같은 [가드레일](guardrails.md) 관련 리소스를 생성합니다.
+ AgentGuardrail([AWS::Bedrock::Guardrail](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide /aws-resource-bedrock-guardrail.html)) - 콘텐츠 필터링, 주제 정책 및 PII 보호를 제공하는 가드레일. 이 가드레일은 에이전트 스택의 에이전트에 연결됩니다.
+ AgentGuardrailVersion([AWS::Bedrock::GuardrailVersion](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide /aws-resource-bedrock-guardrailversion.html)) - 에이전트에 적용된 `AgentGuardrail` 리소스의 버전.
------
#### [ YAML ]
```
AWSTemplateFormatVersion: "2010-09-09"
Description: "[AWSDocs] AmazonBedrockDocs: getting-started-mortgage-flow"
Parameters:
GuardrailName:
Type: String
Description: Name for guardrail
Default: MortgageGuardrail
Resources:
AgentGuardrail:
Type: AWS::Bedrock::Guardrail
Properties:
Name: !Sub AWSDocsTutorial-${GuardrailName}
Description: Guardrail for mortgage processing with investment advice blocking, content filtering, and PII protection
BlockedInputMessaging: "Sorry, the model cannot answer this question."
BlockedOutputsMessaging: "Sorry, the model cannot answer this question."
TopicPolicyConfig:
TopicsConfig:
- Name: InvestmentAdvice
Definition: "Investment advice refers to inquires, guidance or recommendations regarding the management or allocation of fund or asset with the goal of generating returns or achieving specific financial objectives"
Examples:
- "Is investing in the stocks better than bonds?"
- "Should I invest in gold?"
Type: DENY
ContentPolicyConfig:
FiltersConfig:
- Type: VIOLENCE
InputStrength: HIGH
OutputStrength: HIGH
- Type: PROMPT_ATTACK
InputStrength: HIGH
OutputStrength: NONE
- Type: MISCONDUCT
InputStrength: HIGH
OutputStrength: HIGH
- Type: HATE
InputStrength: HIGH
OutputStrength: HIGH
- Type: SEXUAL
InputStrength: HIGH
OutputStrength: HIGH
- Type: INSULTS
InputStrength: HIGH
OutputStrength: HIGH
WordPolicyConfig:
WordsConfig:
- Text: "crypto currency"
- Text: "bitcoin"
ManagedWordListsConfig:
- Type: PROFANITY
SensitiveInformationPolicyConfig:
PiiEntitiesConfig:
- Type: EMAIL
Action: ANONYMIZE
- Type: CREDIT_DEBIT_CARD_NUMBER
Action: BLOCK
ContextualGroundingPolicyConfig:
FiltersConfig:
- Type: GROUNDING
Threshold: 0.85
- Type: RELEVANCE
Threshold: 0.5
AgentGuardrailVersion:
Type: AWS::Bedrock::GuardrailVersion
Properties:
GuardrailIdentifier: !Ref AgentGuardrail
Description: Version 1 of the mortgage agent guardrail
Outputs:
GuardrailArn:
Value:
Ref: AgentGuardrail
Description: ARN of guardrail to associate with agent
GuardrailVersion:
Value:
Fn::GetAtt:
- AgentGuardrailVersion
- Version
Description: Version of guardrail to associate with agent
```
------
#### [ JSON ]
```
{
"AWSTemplateFormatVersion": "2010-09-09",
"Description": "[AWSDocs] AmazonBedrockDocs: getting-started-mortgage-flow",
"Parameters": {
"GuardrailName": {
"Type": "String",
"Description": "Name for guardrail",
"Default": "MortgageGuardrail"
}
},
"Resources": {
"AgentGuardrail": {
"Type": "AWS::Bedrock::Guardrail",
"Properties": {
"Name": {
"Fn::Sub": "AWSDocsTutorial-${GuardrailName}"
},
"Description": "Guardrail for mortgage processing with investment advice blocking, content filtering, and PII protection",
"BlockedInputMessaging": "Sorry, the model cannot answer this question.",
"BlockedOutputsMessaging": "Sorry, the model cannot answer this question.",
"TopicPolicyConfig": {
"TopicsConfig": [
{
"Name": "InvestmentAdvice",
"Definition": "Investment advice refers to inquires, guidance or recommendations regarding the management or allocation of fund or asset with the goal of generating returns or achieving specific financial objectives",
"Examples": [
"Is investing in the stocks better than bonds?",
"Should I invest in gold?"
],
"Type": "DENY"
}
]
},
"ContentPolicyConfig": {
"FiltersConfig": [
{
"Type": "VIOLENCE",
"InputStrength": "HIGH",
"OutputStrength": "HIGH"
},
{
"Type": "PROMPT_ATTACK",
"InputStrength": "HIGH",
"OutputStrength": "NONE"
},
{
"Type": "MISCONDUCT",
"InputStrength": "HIGH",
"OutputStrength": "HIGH"
},
{
"Type": "HATE",
"InputStrength": "HIGH",
"OutputStrength": "HIGH"
},
{
"Type": "SEXUAL",
"InputStrength": "HIGH",
"OutputStrength": "HIGH"
},
{
"Type": "INSULTS",
"InputStrength": "HIGH",
"OutputStrength": "HIGH"
}
]
},
"WordPolicyConfig": {
"WordsConfig": [
{
"Text": "crypto currency"
},
{
"Text": "bitcoin"
}
],
"ManagedWordListsConfig": [
{
"Type": "PROFANITY"
}
]
},
"SensitiveInformationPolicyConfig": {
"PiiEntitiesConfig": [
{
"Type": "EMAIL",
"Action": "ANONYMIZE"
},
{
"Type": "CREDIT_DEBIT_CARD_NUMBER",
"Action": "BLOCK"
}
]
},
"ContextualGroundingPolicyConfig": {
"FiltersConfig": [
{
"Type": "GROUNDING",
"Threshold": 0.85
},
{
"Type": "RELEVANCE",
"Threshold": 0.5
}
]
}
}
},
"AgentGuardrailVersion": {
"Type": "AWS::Bedrock::GuardrailVersion",
"Properties": {
"GuardrailIdentifier": {
"Ref": "AgentGuardrail"
},
"Description": "Version 1 of the mortgage agent guardrail"
}
}
},
"Outputs": {
"GuardrailArn": {
"Value": {
"Ref": "AgentGuardrail"
},
"Description": "ARN of guardrail to associate with agent"
},
"GuardrailVersion": {
"Value": {
"Fn::GetAtt": [
"AgentGuardrailVersion",
"Version"
]
},
"Description": "Version of guardrail to associate with agent"
}
}
}
```
------
## Amazon Bedrock Prompt Management 스택
이 스택은 흐름에 추가되는 다음 [프롬프트](prompt-management.md)([AWS::IAM::Prompt](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide /aws-resource-bedrock-prompt.html)) 리소스를 생성합니다.
+ RejectionPrompt - 금융 정보를 기반으로 생성된 거부 서신을 반환하는 프롬프트.
+ ProcessApplicationPrompt - 에이전트에게 고객의 금융 정보를 보내고 고객이 대출을 받을 자격이 있는지 평가하라는 메시지를 보내는 프롬프트.
------
#### [ YAML ]
```
AWSTemplateFormatVersion: "2010-09-09"
Description: "[AWSDocs] AmazonBedrockDocs: getting-started-mortgage-flow"
Resources:
RejectionPrompt:
Type: AWS::Bedrock::Prompt
Properties:
Name: !Sub AWSDocsTutorial-RejectionPrompt
Description: "Use this prompt to generate a rejection letter triggered by an unsatisfactory income to debt ratio"
DefaultVariant: variantOne
Variants:
- Name: variantOne
TemplateType: TEXT
ModelId: anthropic.claude-3-haiku-20240307-v1:0
TemplateConfiguration:
Text:
Text: |
Write a mortgage loan rejection letter for a candiate with income {{income}}, totalDebt {{totalDebt}}, loanAmount {{loanAmount}}.
The reason for rejection is their income to debt ratio.
Do not mention any other reason.
Make the letter as concise as possible.
Treat all numeric inputs as whole numbers.
Let the general structure be like the below:
Dear [Applicant's Name],
We appreciate your interest in obtaining a mortgage loan with our institution...
The primary reason for this decision is that ...
While we understand that this news may be disappointing, ...
Thank you again for your interest, and we wish you the best in your future endeavors...
Sincerely,
[Your Institution's Name]
InputVariables:
- Name: income
- Name: totalDebt
- Name: loanAmount
InferenceConfiguration:
Text:
MaxTokens: 2000
Temperature: 0.0
TopP: 0.999
StopSequences:
- "\n\nHuman:"
AdditionalModelRequestFields:
top_k: 250
ProcessApplicationPrompt:
Type: AWS::Bedrock::Prompt
Properties:
Name: !Sub AWSDocsTutorial-ProcessApplicationPrompt
Description: "Use this prompt to generate a question for an agent to process the mortgage application"
DefaultVariant: variantOne
Variants:
- Name: variantOne
TemplateType: TEXT
ModelId: anthropic.claude-3-haiku-20240307-v1:0
TemplateConfiguration:
Text:
Text: |
Generate a question asking if the user will qualify for a loan for the specified criteria.
Include instruction to base the answer on key features of the property retrieved from MLS listing.
Start with "will an applicant...".
{ "income": {{income}}, "creditScore": {{creditScore}}, "totalDebt": {{totalDebt}}, "loanAmount": {{loanAmount}}, "mlsId": {{mlsId}} }
Include a second question on loan requirements an applicant with the below attributes should consider for a Fannie Mae backed loan (other than debt to income).
InputVariables:
- Name: income
- Name: creditScore
- Name: totalDebt
- Name: loanAmount
- Name: mlsId
InferenceConfiguration:
Text:
MaxTokens: 2000
Temperature: 0.0
TopP: 0.999
StopSequences:
- "\n\nHuman:"
AdditionalModelRequestFields:
top_k: 250
Outputs:
ProcessApplicationPromptArn:
Value:
Ref: ProcessApplicationPrompt
Description: ARN of the prompt to process a mortgage application
RejectionPromptArn:
Value:
Ref: RejectionPrompt
Description: ARN of the prompt to reject a mortgage application
```
------
#### [ JSON ]
```
{
"AWSTemplateFormatVersion": "2010-09-09",
"Description": "[AWSDocs] AmazonBedrockDocs: getting-started-mortgage-flow",
"Resources": {
"RejectionPrompt": {
"Type": "AWS::Bedrock::Prompt",
"Properties": {
"Name": {
"Fn::Sub": "AWSDocsTutorial-RejectionPrompt"
},
"Description": "Use this prompt to generate a rejection letter triggered by an unsatisfactory income to debt ratio",
"DefaultVariant": "variantOne",
"Variants": [
{
"Name": "variantOne",
"TemplateType": "TEXT",
"ModelId": "anthropic.claude-3-haiku-20240307-v1:0",
"TemplateConfiguration": {
"Text": {
"Text": "Write a mortgage loan rejection letter for a candiate with income {{income}}, totalDebt {{totalDebt}}, loanAmount {{loanAmount}}. \nThe reason for rejection is their income to debt ratio. \nDo not mention any other reason. \nMake the letter as concise as possible. \nTreat all numeric inputs as whole numbers.\nLet the general structure be like the below:\n\nDear [Applicant's Name],\nWe appreciate your interest in obtaining a mortgage loan with our institution...\nThe primary reason for this decision is that ...\nWhile we understand that this news may be disappointing, ...\nThank you again for your interest, and we wish you the best in your future endeavors...\n\nSincerely,\n[Your Institution's Name]\n",
"InputVariables": [
{
"Name": "income"
},
{
"Name": "totalDebt"
},
{
"Name": "loanAmount"
}
]
}
},
"InferenceConfiguration": {
"Text": {
"MaxTokens": 2000,
"Temperature": 0.0,
"TopP": 0.999,
"StopSequences": [
"\n\nHuman:"
]
}
},
"AdditionalModelRequestFields": {
"top_k": 250
}
}
]
}
},
"ProcessApplicationPrompt": {
"Type": "AWS::Bedrock::Prompt",
"Properties": {
"Name": {
"Fn::Sub": "AWSDocsTutorial-ProcessApplicationPrompt"
},
"Description": "Use this prompt to generate a question for an agent to process the mortgage application",
"DefaultVariant": "variantOne",
"Variants": [
{
"Name": "variantOne",
"TemplateType": "TEXT",
"ModelId": "anthropic.claude-3-haiku-20240307-v1:0",
"TemplateConfiguration": {
"Text": {
"Text": "Generate a question asking if the user will qualify for a loan for the specified criteria. \n\nInclude instruction to base the answer on key features of the property retrieved from MLS listing. \n\nStart with \"will an applicant...\".\n\n{ \"income\": {{income}}, \"creditScore\": {{creditScore}}, \"totalDebt\": {{totalDebt}}, \"loanAmount\": {{loanAmount}}, \"mlsId\": {{mlsId}} }\n\nInclude a second question on loan requirements an applicant with the below attributes should consider for a Fannie Mae backed loan (other than debt to income).\n",
"InputVariables": [
{
"Name": "income"
},
{
"Name": "creditScore"
},
{
"Name": "totalDebt"
},
{
"Name": "loanAmount"
},
{
"Name": "mlsId"
}
]
}
},
"InferenceConfiguration": {
"Text": {
"MaxTokens": 2000,
"Temperature": 0.0,
"TopP": 0.999,
"StopSequences": [
"\n\nHuman:"
]
}
},
"AdditionalModelRequestFields": {
"top_k": 250
}
}
]
}
}
},
"Outputs": {
"ProcessApplicationPromptArn": {
"Value": {
"Ref": "ProcessApplicationPrompt"
},
"Description": "ARN of the prompt to process a mortgage application"
},
"RejectionPromptArn": {
"Value": {
"Ref": "RejectionPrompt"
},
"Description": "ARN of the prompt to reject a mortgage application"
}
}
}
```
------
## Amazon Bedrock Knowledge Bases 스택
이 템플릿은 대출 지침이 포함된 [지식 기반](knowledge-base.md)과 해당 데이터 소스를 생성합니다.
+ KnowledgeBase([AWS::Bedrock::KnowledgeBase](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide /aws-resource-bedrock-knowledgebase.html))
+ KnowledgeBaseDataSource([AWS::Bedrock::DataSource](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide /aws-resource-bedrock-datasource.html))
------
#### [ YAML ]
```
AWSTemplateFormatVersion: '2010-09-09'
Description: "[AWSDocs] AmazonBedrockDocs: getting-started-mortgage-flow"
Parameters:
KnowledgeBaseName:
Type: String
Description: Name of knowledge base
Default: MortgageKB
Q01pS3BucketName:
Type: String
Description: Name of S3 bucket where knowledge base data is stored
Q06pKBEmbedModel:
Type: String
Description: Selected Embedding model
Q07pKBChunkingStrategy:
Type: String
Description: Selected Chunking strategy
Q08pKBMaxTokens:
Type: Number
Description: Maximum number of tokens in a chunk
Q09pKBOverlapPercentage:
Type: Number
Description: Percent overlap in each chunk
Q11pOSSCollectionName:
Type: String
Description: Name of the Collection
Q12pOSSIndexName:
Type: String
Description: Index name to be created in vector store
Q13pVectorFieldName:
Type: String
Description: Vector field name
Default: bedrock-knowledge-base-default-vector
Q14pMetaDataFieldName:
Type: String
Description: Metadata field name
Default: AMAZON_BEDROCK_METADATA
Q15pTextFieldName:
Type: String
Description: Text field name
Default: AMAZON_BEDROCK_TEXT_CHUNK
pCollectionArn:
Type: String
Description: Name of the Collection Arn
pKBRole:
Type: String
Description: KB role for e2e RAG
pKBRoleArn:
Type: String
Description: KB role Arn for e2e RAG
Conditions:
IsChunkingStrategyFixed:
Fn::Equals:
- Ref: Q07pKBChunkingStrategy
- Fixed-size chunking
IsChunkingStrategyDefault:
Fn::Equals:
- Ref: Q07pKBChunkingStrategy
- Default chunking
IsChunkingStrategyNoChunking:
Fn::Equals:
- Ref: Q07pKBChunkingStrategy
- No chunking
IsChunkingStrategyFixedOrDefault:
Fn::Or:
- Condition: IsChunkingStrategyFixed
- Condition: IsChunkingStrategyDefault
Resources:
KnowledgeBase:
Type: AWS::Bedrock::KnowledgeBase
Properties:
Description: Test KB Deployment
KnowledgeBaseConfiguration:
Type: VECTOR
VectorKnowledgeBaseConfiguration:
EmbeddingModelArn:
Fn::Sub: arn:aws:bedrock:${AWS::Region}::foundation-model/${Q06pKBEmbedModel}
Name: !Sub AWSDocsTutorial-${KnowledgeBaseName}
RoleArn:
Ref: pKBRoleArn
StorageConfiguration:
OpensearchServerlessConfiguration:
CollectionArn:
Ref: pCollectionArn
FieldMapping:
MetadataField:
Ref: Q14pMetaDataFieldName
TextField:
Ref: Q15pTextFieldName
VectorField:
Ref: Q13pVectorFieldName
VectorIndexName:
Ref: Q12pOSSIndexName
Type: OPENSEARCH_SERVERLESS
KnowledgeBaseDataSource:
Type: AWS::Bedrock::DataSource
DependsOn:
- KnowledgeBase
Properties:
DataSourceConfiguration:
Type: S3
S3Configuration:
BucketArn:
Fn::Sub: arn:aws:s3:::${Q01pS3BucketName}
InclusionPrefixes:
- knowledge-base-data-source/
Description: Knowledge base data source
KnowledgeBaseId:
Ref: KnowledgeBase
Name: !Sub AWSDocsTutorial-${KnowledgeBaseName}-DS
VectorIngestionConfiguration:
ChunkingConfiguration:
Fn::If:
- IsChunkingStrategyFixed
- ChunkingStrategy: FIXED_SIZE
FixedSizeChunkingConfiguration:
MaxTokens: !Ref Q08pKBMaxTokens
OverlapPercentage: !Ref Q09pKBOverlapPercentage
- Fn::If:
- IsChunkingStrategyDefault
- ChunkingStrategy: FIXED_SIZE
FixedSizeChunkingConfiguration:
MaxTokens: 300
OverlapPercentage: 20
- Fn::If:
- IsChunkingStrategyNoChunking
- ChunkingStrategy: NONE
- !Ref AWS::NoValue
Outputs:
KBId:
Value:
Ref: KnowledgeBase
Description: KnowledgeBase ID
DS:
Value:
Ref: KnowledgeBaseDataSource
Description: KnowledgeBase Datasource
```
------
#### [ JSON ]
```
{
"AWSTemplateFormatVersion": "2010-09-09",
"Description": "[AWSDocs] AmazonBedrockDocs: getting-started-mortgage-flow",
"Parameters": {
"KnowledgeBaseName": {
"Type": "String",
"Description": "Name of knowledge base",
"Default": "MortgageKB"
},
"Q01pS3BucketName": {
"Type": "String",
"Description": "Name of S3 bucket where knowledge base data is stored"
},
"Q06pKBEmbedModel": {
"Type": "String",
"Description": "Selected Embedding model"
},
"Q07pKBChunkingStrategy": {
"Type": "String",
"Description": "Selected Chunking strategy"
},
"Q08pKBMaxTokens": {
"Type": "Number",
"Description": "Maximum number of tokens in a chunk"
},
"Q09pKBOverlapPercentage": {
"Type": "Number",
"Description": "Percent overlap in each chunk"
},
"Q11pOSSCollectionName": {
"Type": "String",
"Description": "Name of the Collection"
},
"Q12pOSSIndexName": {
"Type": "String",
"Description": "Index name to be created in vector store"
},
"Q13pVectorFieldName": {
"Type": "String",
"Description": "Vector field name",
"Default": "bedrock-knowledge-base-default-vector"
},
"Q14pMetaDataFieldName": {
"Type": "String",
"Description": "Metadata field name",
"Default": "AMAZON_BEDROCK_METADATA"
},
"Q15pTextFieldName": {
"Type": "String",
"Description": "Text field name",
"Default": "AMAZON_BEDROCK_TEXT_CHUNK"
},
"pCollectionArn": {
"Type": "String",
"Description": "Name of the Collection Arn"
},
"pKBRole": {
"Type": "String",
"Description": "KB role for e2e RAG"
},
"pKBRoleArn": {
"Type": "String",
"Description": "KB role Arn for e2e RAG"
}
},
"Conditions": {
"IsChunkingStrategyFixed": {
"Fn::Equals": [
{
"Ref": "Q07pKBChunkingStrategy"
},
"Fixed-size chunking"
]
},
"IsChunkingStrategyDefault": {
"Fn::Equals": [
{
"Ref": "Q07pKBChunkingStrategy"
},
"Default chunking"
]
},
"IsChunkingStrategyNoChunking": {
"Fn::Equals": [
{
"Ref": "Q07pKBChunkingStrategy"
},
"No chunking"
]
},
"IsChunkingStrategyFixedOrDefault": {
"Fn::Or": [
{
"Condition": "IsChunkingStrategyFixed"
},
{
"Condition": "IsChunkingStrategyDefault"
}
]
}
},
"Resources": {
"KnowledgeBase": {
"Type": "AWS::Bedrock::KnowledgeBase",
"Properties": {
"Description": "Test KB Deployment",
"KnowledgeBaseConfiguration": {
"Type": "VECTOR",
"VectorKnowledgeBaseConfiguration": {
"EmbeddingModelArn": {
"Fn::Sub": "arn:aws:bedrock:${AWS::Region}::foundation-model/${Q06pKBEmbedModel}"
}
}
},
"Name": {
"Fn::Sub": "AWSDocsTutorial-${KnowledgeBaseName}"
},
"RoleArn": {
"Ref": "pKBRoleArn"
},
"StorageConfiguration": {
"OpensearchServerlessConfiguration": {
"CollectionArn": {
"Ref": "pCollectionArn"
},
"FieldMapping": {
"MetadataField": {
"Ref": "Q14pMetaDataFieldName"
},
"TextField": {
"Ref": "Q15pTextFieldName"
},
"VectorField": {
"Ref": "Q13pVectorFieldName"
}
},
"VectorIndexName": {
"Ref": "Q12pOSSIndexName"
}
},
"Type": "OPENSEARCH_SERVERLESS"
}
}
},
"KnowledgeBaseDataSource": {
"Type": "AWS::Bedrock::DataSource",
"DependsOn": [
"KnowledgeBase"
],
"Properties": {
"DataSourceConfiguration": {
"Type": "S3",
"S3Configuration": {
"BucketArn": {
"Fn::Sub": "arn:aws:s3:::${Q01pS3BucketName}"
},
"InclusionPrefixes": [
"knowledge-base-data-source/"
]
}
},
"Description": "Knowledge base data source",
"KnowledgeBaseId": {
"Ref": "KnowledgeBase"
},
"Name": {
"Fn::Sub": "AWSDocsTutorial-${KnowledgeBaseName}-DS"
},
"VectorIngestionConfiguration": {
"ChunkingConfiguration": {
"Fn::If": [
"IsChunkingStrategyFixed",
{
"ChunkingStrategy": "FIXED_SIZE",
"FixedSizeChunkingConfiguration": {
"MaxTokens": {
"Ref": "Q08pKBMaxTokens"
},
"OverlapPercentage": {
"Ref": "Q09pKBOverlapPercentage"
}
}
},
{
"Fn::If": [
"IsChunkingStrategyDefault",
{
"ChunkingStrategy": "FIXED_SIZE",
"FixedSizeChunkingConfiguration": {
"MaxTokens": 300,
"OverlapPercentage": 20
}
},
{
"Fn::If": [
"IsChunkingStrategyNoChunking",
{
"ChunkingStrategy": "NONE"
},
{
"Ref": "AWS::NoValue"
}
]
}
]
}
]
}
}
}
}
},
"Outputs": {
"KBId": {
"Value": {
"Ref": "KnowledgeBase"
},
"Description": "KnowledgeBase ID"
},
"DS": {
"Value": {
"Ref": "KnowledgeBaseDataSource"
},
"Description": "KnowledgeBase Datasource"
}
}
}
```
------