generative-ai-use-cases icon indicating copy to clipboard operation
generative-ai-use-cases copied to clipboard

変数名idTokenPayloadの誤記修正

Open hideakiaoyagi opened this issue 9 months ago • 2 comments

変更内容の説明

RAG (Bedrock Knowledge Base) ユースケースのメタデータフィルタリング機能のうち「Dynamic Filter」を有効にするために rag-knowledge-base.ts のコメントアウト部分を解除してデプロイを試みると、コンパイルエラーが発生します。

TSError: ⨯ Unable to compile TypeScript:
../common/src/custom/rag-knowledge-base.ts:26:18 - error TS2552: Cannot find name 'idTokenPayload'. Did you mean '_idTokenPayload'?

エラーメッセージに従って、コメントアウト部分のコードに登場する idTokenPayload (2箇所) を _idTokenPayload に修正しました。

(コメントアウト部分であるのでPRするか迷いましたが・・・ご無礼ありましたら申し訳ございません)

チェック項目

  • [x] npm run lint を実行した
  • [ ] 関連するドキュメントを修正した
  • [x] 手元の環境で動作確認済み
  • [ ] npm run cdk:test を実行しスナップショット差分がある場合は npm run cdk:test:update-snapshot を実行してスナップショットを更新した

関連する Issue

なし

hideakiaoyagi avatar Feb 28 '25 10:02 hideakiaoyagi

ありがとうございます。こちら、_idTokenPlayload としているのは typescript の unused variable の警告を避けるためになっています。よって、コードとしては idTokenPayload の方が正しいので、もし修正するとしたら _idTokenPayload の上に「これは...の理由で _ prefix が入っているため、アンコメントする際は _ を削除してください」の方が正しいかと思います。こちらについてはいかがでしょうか。

tbrand avatar Mar 03 '25 01:03 tbrand

コメントありがとうございます。 なるほど、ここのやり取りですね。見落としてましたスミマセン。

できれば「フィルター機能を有効化する際に変数名を変更する」という作業を発生させないのが理想だと思いました。 eslint-disable-line no-unused-vars 等が使えるとよいと思ったのですが、setter定義には使えないですね・・・

すみません、よい案を思いつかないので、ご提案通りコメントの指示で対応するのが現実解かなと思いました。 何かよい案ありましたらご指摘ください。

hideakiaoyagi avatar Mar 03 '25 05:03 hideakiaoyagi

Thank you for your Pull Request. Since there has been no progress on this, I will close it for now. I look forward to your continued cooperation.

tbrand avatar Jun 02 '25 03:06 tbrand