スタンドアロンの Text ユースケースのデプロイ

SageMakerChat.template

UseCaseUUID

<_入力必須_>

アプリケーション内でデプロイされたこのユースケースを識別するための 36 文字の UUIDv4。

UseCaseConfigRecordKey

<_入力必須_>

ランタイム時にチャットプロバイダー Lambda が必要とする設定を含むレコードに対応するキー。テーブル内のレコードには、この値に一致する key 属性と、必要な設定を含む config 属性が必要です。このレコードは、使用中の場合はデプロイプラットフォームによって入力されます。このユースケースをスタンドアロンでデプロイする場合は、UseCaseConfigTableName で定義されたテーブルに、手動で作成したエントリを追加する必要があります。

UseCaseConfigTableName

<_入力必須_>

スタックは、この名前のテーブルからキー UseCaseConfigRecordKey で設定を読み込みます。

ExistingRestApiId

(オプション入力)

使用する既存の API Gateway REST API ID。指定しない場合、新しい API Gateway REST API が作成されます。通常、デプロイダッシュボードからデプロイするときに提供されます。

注: 既存の API を使用すると、複数のスタンドアロンユースケースをデプロイする必要がある場合に、リソースの重複を減らしAPI の管理を簡素化できます。スタンドアロンのユースケースに既存の API を提供する場合、API に必要なルート (複数可) と想定されるモデルが設定されていることを確認する責任があります。必要な事前設定済みの /details ルート (チャット中にユースケースの詳細を取得) と、オプションで /feedback ルート (FeedbackEnabled が Yes に設定されている場合、LLM チャットレスポンスのフィードバックの収集を有効にする) を設定する必要があります。さらに、ExistingApiRootResourceId、ExistingCognitoUserPoolId、および ExistingCognitoGroupPolicyTableName も指定する必要があります。

ExistingApiRootResourceId

(オプション入力)

使用する既存の API Gateway REST API ルートリソース ID。REST API ルートリソース ID は、API の「リソース」セクションでルートリソース (/) を選択することで、AWS コンソールから取得できます。リソース ID がリソース詳細パネルに表示されます。または、REST API で describe API コールを実行して、ルートリソース ID を見つけることもできます。

FeedbackEnabled

No

[いいえ] に設定すると、デプロイされたユースケーススタックはフィードバック機能にアクセスできなくなります。

ExistingModelInfoTableName

(オプション入力)

モデル情報とデフォルト値を含む DynamoDB テーブルの名前。デプロイプラットフォームによって使用されます。省略すると、モデルのデフォルト値を格納する新しいテーブルが作成されます。

DefaultUserEmail

placeholder@example.com

このユースケースのデフォルトユーザーの E メール。この E メールの Amazon Cognito ユーザーが作成され、ユースケースへのアクセスに使用されます。指定しない場合、Cognito グループとユーザーは作成されません。placeholder@example.com を使用してユーザーではなくグループを作成することもできます。ユーザープールの設定については、「手動ユーザープール設定」を参照してください。

ExistingCognitoUserPoolId

(オプション入力)

このユースケースの認証に使用する既存の Amazon Cognito ユーザープールの UserPoolId。通常、デプロイダッシュボードからデプロイする場合に指定しますが、このユースケーススタックをスタンドアロンでデプロイする場合は省略できます。

CognitoDomainPrefix

(オプション入力)

Cognito ユーザープールクライアントのドメインを指定する場合は、値を入力します。値を指定しない場合、デプロイによって値が生成されます。

ExistingCognitoUserPoolClient

(オプション入力)

既存のユーザープールクライアント (アプリクライアント) を使用する場合に指定します。ユーザープールクライアントを指定しない場合、新しいクライアントが作成されます。このパラメータは、既存のユーザープール ID が指定されている場合にのみ指定できます。

ExistingCognitoGroupPolicyTableName

(オプション入力)

ユーザーグループポリシーを格納する DynamoDB テーブルの名前。これは、ユースケースの API でカスタムオーソライザーによって使用されます。通常、デプロイプラットフォームからデプロイする際に入力を指定できますが、このユースケーススタックをスタンドアロンでデプロイする場合は省略できます。

RAGEnabled

true

true に設定すると、デプロイされたユースケーススタックは、RAG 機能を提供するために作成された、指定の Amazon Kendra インデックスを使用します。false に設定すると、ユーザーは LLM と直接やり取りします。

KnowledgeBaseType

Bedrock

RAG に使用するナレッジベースタイプ。RAGEnabled が true の場合にのみ設定されます。Bedrock または Kendra を使用できます。

注: RAGEnabled が true の場合にのみ該当します。

ExistingKendraIndexId

(オプション入力)

ユースケースで使用する既存の Kendra インデックスのインデックス ID。何も指定されておらず、KnowledgeBaseType が Kendra の場合、新しいインデックスが作成されます。

注: RAGEnabled が true で、KnowledgeBaseType が Kendra の場合にのみ該当します。

NewKendraIndexName

(オプション入力)

このユースケース用に新しく作成される Kendra インデックスの名前。ExistingKendraIndexId が指定されていない場合にのみ適用されます。

注: RAGEnabled が true で、KnowledgeBaseType が Kendra の場合にのみ該当します。

NewKendraQueryCapacityUnits

0

このユースケース用に新しく作成される Amazon Kendra インデックスの追加クエリキャパシティーユニット。ExistingKendraIndexId が指定されていない場合にのみ適用されます。「CapacityUnitsConfiguration」を参照してください。

注: RAGEnabled が true で、KnowledgeBaseType が Kendra の場合にのみ該当します。

NewKendraStorageCapacityUnits

0

このユースケース用に新しく作成される Amazon Kendra インデックスの追加ストレージキャパシティユニット。ExistingKendraIndexId が指定されていない場合にのみ適用されます。「CapacityUnitsConfiguration」を参照してください。

注: RAGEnabled が true で、KnowledgeBaseType が Kendra の場合にのみ該当します。

NewKendraIndexEdition

(オプション入力)

このユースケース用に新しく作成される Amazon Kendra インデックスに使用する Amazon Kendra のエディション。ExistingKendraIndexId が指定されていない場合にのみ適用されます。「Amazon Kendra Editions」を参照してください。

注: RAGEnabled が true で、KnowledgeBaseType が Kendra の場合にのみ該当します。

BedrockKnowledgeBaseId

(オプション入力)

RAG ユースケースで使用する Bedrock ナレッジベースの ID。ExistingKendraIndexId または NewKendraIndexName が指定されている場合は指定できません。

注: RAGEnabled が true で、KnowledgeBaseType が Bedrock の場合にのみ該当します。

VpcEnabled

No

スタックのリソースを VPC 内にデプロイするべきかどうか。

CreateNewVpc

No

ソリューションで新しい VPC を作成し、このユースケースで使用する場合は、Yes を選択します。

注: VpcEnabled が Yes の場合にのみ該当します。

IPAMPoolId

(オプション入力)

Amazon VPC IP Address Manager を使用して CIDR 範囲を割り当てる場合は、使用する IPAM プール ID を指定します。

注: VpcEnabled が Yes で、CreateNewVpc が No の場合にのみ該当します。

ExistingVpcId

(オプション入力)

ユースケースに使用する既存の VPC の VPC ID。

注: VpcEnabled が Yes で、CreateNewVpc が No の場合にのみ該当します。

ExistingPrivateSubnetIds

(オプション入力)

Lambda 関数のデプロイに使用する既存のプライベートサブネットのサブネット ID のカンマ区切りリスト。

注: VpcEnabled が Yes で、CreateNewVpc が No の場合にのみ該当します。

ExistingSecurityGroupIds

(オプション入力)

Lambda 関数の設定に使用する既存の VPC のセキュリティグループのカンマ区切りリスト。

注: VpcEnabled が Yes で、CreateNewVpc が No の場合にのみ該当します。

VpcAzs

(オプション入力)

VPC のサブネットが作成される AZ のカンマ区切りリスト

注: VpcEnabled が Yes で、CreateNewVpc が No の場合にのみ該当します。

UseInferenceProfile

No

設定されたモデルが Bedrock の場合、Bedrock 推論プロファイルを使用しているかどうかを指定できます。これにより、スタックのデプロイ時に必要な IAM ポリシーが確実に設定されます。詳細については、次の「https://docs.aws.amazon.com/bedrock/latest/userguide/cross-region-inference.html」を参照してください。

DeployUI

はい

このデプロイでフロントエンド UI をデプロイするかどうかを選択します。No を選択すると、API をホストするインフラストラクチャ、API の認証、バックエンド処理のみが作成されます。