Amazon Bedrock Knowledge Base用のサービスロールを作成します。

このツールは、Bedrock Knowledge Baseが使用するIAMロールを作成します。 ロールには以下の信頼ポリシーが設定されます:

• Service: bedrock.amazonaws.com

• Condition: aws:SourceAccountとaws:SourceArnによる制限

  • aws:SourceAccount: 現在のAWSアカウントID

  • aws:SourceArn: arn:aws:bedrock:[REGION]:[ACCOUNT_ID]:knowledge-base/*

Args: role_name: 作成するIAMロールの名前（必須） 例: "BedrockKnowledgeBaseRole" 注意: ロール名はAWSアカウント内で一意である必要があります region: Knowledge Baseを作成する先のリージョン（デフォルト: "us-east-1"） 例: "us-east-1", "ap-northeast-1" 注意: 信頼ポリシーのaws:SourceArnにこのリージョンが使用されます このリージョンは、Knowledge Baseを作成する際に指定するリージョンと一致させる必要があります description: ロールの説明（デフォルト: "Bedrock Knowledge Base access"） max_session_duration: 最大セッション時間（秒）（デフォルト: 3600秒 = 1時間） 範囲: 3600秒（1時間）から43200秒（12時間）まで

Returns: IAMRoleCreateResponseDict: ロール作成結果 - role_name: 作成されたロール名 - role_arn: ロールのARN（arn:aws:iam::ACCOUNT_ID:role/service-role/ROLE_NAME形式） - path: ロールのパス（/service-role/） - status: 作成ステータス（"created"）

Raises: ValueError: role_nameが空の場合、またはmax_session_durationが無効な範囲の場合 ClientError: AWS API呼び出しが失敗した場合 例: ロール名が既に使用されている、権限がないなど

Example: # 基本的なロール作成（デフォルトリージョン） create_bedrock_kb_role("BedrockKnowledgeBaseRole")

# 特定のリージョン用のロール作成
create_bedrock_kb_role("BedrockKnowledgeBaseRole", region="ap-northeast-1")

# カスタム説明とセッション時間を指定
create_bedrock_kb_role(
    "MyBedrockRole",
    description="Custom Bedrock KB role",
    max_session_duration=7200
)

Note: - ロールは /service-role/ パスに作成されます - 信頼ポリシーには、現在のAWSアカウントIDとリージョンが自動的に設定されます - ロール作成後、適切な権限ポリシーをアタッチする必要があります - ロール名が既に使用されている場合、EntityAlreadyExistsエラーが発生します

Knowledge Baseにデータソースを作成します。

データソースは、Knowledge Baseがデータを取得する場所を定義します。 S3バケットを指定し、必要に応じて特定のプレフィックス（フォルダ）のみを 含めることができます。パーシング設定とチャンキング設定を指定することで、 データソースごとに異なる処理方法を適用できます。

注意: Knowledge Baseのstorage_typeがS3_VECTORSでも、データソースのtypeは 常にS3になります。これらは異なる概念です：

• storage_type: Knowledge Baseのストレージ設定（S3またはS3_VECTORS）

• dataSourceConfiguration.type: データソースのタイプ（S3, WEB, CONFLUENCEなど）

Args: knowledge_base_id: データソースを追加するKnowledge BaseのID name: データソースの名前（1-100文字） source_type: データソースタイプ（現在は'S3'のみサポート、デフォルト: 'S3'） bucket_arn: データソースとして使用するS3バケットのARN（arn:aws:s3:::BUCKET_NAME形式） inclusion_prefixes: 含めるS3プレフィックスのカンマ区切り文字列（オプション） 例: "documents/,images/" のように複数のプレフィックスを指定可能 空文字列の場合はバケット内のすべてのオブジェクトが対象

パーシング設定（オプション）:
parsing_strategy: パーシング戦略
    - 'BEDROCK_FOUNDATION_MODEL': Foundation Modelを使用したパーシング
      （マルチモーダルデータ（画像、表、グラフなど）を処理可能、プロンプトカスタマイズ可能）
    - 'BEDROCK_DATA_AUTOMATION': Bedrock Data Automationを使用したパーシング
      （マルチモーダルデータを処理可能、完全マネージド、追加プロンプト不要）
    注意: 指定しない場合はKnowledge Baseのデフォルト設定が使用されます
parsing_model_arn: Foundation ModelのARN（parsing_strategy='BEDROCK_FOUNDATION_MODEL'の場合必須）
    例: "arn:aws:bedrock:us-east-1::foundation-model/anthropic.claude-3-sonnet-20240229-v1:0"
    サポートされているモデル: Claude 3 Sonnet, Claude 3 Opus, Claude 3 Haikuなど
parsing_modality: マルチモーダル設定
    - 'MULTIMODAL': テキストと画像の両方を処理（オプション）
parsing_prompt_text: パーシングプロンプトのテキスト（オプション）
    Foundation Modelにドキュメントの解釈方法を指示するテキスト
    例: "Extract all text, tables, and figures from this document."

チャンキング設定（オプション）:
chunking_strategy: チャンキング戦略
    - 'FIXED_SIZE': 固定サイズのチャンクに分割（推奨: max_tokens=1000, overlap_percentage=20）
    - 'HIERARCHICAL': 階層的なチャンクに分割（大きなチャンクと小さなチャンクの2層）
    - 'SEMANTIC': セマンティックなチャンクに分割（NLPを使用して類似コンテンツでグループ化）
    - 'NONE': チャンクに分割しない（各ファイルが1つのチャンクとして扱われる）
    注意: 指定しない場合はKnowledge Baseのデフォルト設定が使用されます
chunking_max_tokens: 最大トークン数（chunking_strategy='FIXED_SIZE'または'SEMANTIC'の場合に使用）
    - FIXED_SIZE: 1以上（推奨: 500-2000）
    - SEMANTIC: 1以上（推奨: 1000-3000）
chunking_overlap_percentage: オーバーラップ率（chunking_strategy='FIXED_SIZE'の場合に使用）
    範囲: 1-99（推奨: 10-30）
    隣接するチャンク間で重複するトークンの割合
chunking_overlap_tokens: オーバーラップトークン数（chunking_strategy='HIERARCHICAL'の場合に使用）
    階層チャンキングで使用する重複トークン数
chunking_buffer_size: バッファサイズ（chunking_strategy='SEMANTIC'の場合に使用）
    範囲: 0-1（推奨: 1）
    文を比較する際の移動コンテキストウィンドウのサイズ
chunking_breakpoint_threshold: ブレークポイントのパーセンタイル閾値（chunking_strategy='SEMANTIC'の場合に使用）
    範囲: 50-99（推奨: 80-95）
    チャンクを分割するための類似度閾値（低いほど多くのチャンクが作成される）

Returns: DataSourceResponseDict: データソースの作成結果 - data_source_id: 作成されたデータソースのID - status: データソースのステータス（'CREATING', 'ACTIVE', 'FAILED'など）

Raises: ValueError: 入力値が無効な場合（source_typeが無効、バリデーションエラーなど） - source_typeが'S3'以外の場合 - parsing_strategy='BEDROCK_FOUNDATION_MODEL'でparsing_model_arnが指定されていない場合 - ARN形式が無効な場合

Examples: # 基本的なデータソースの作成（デフォルト設定） create_data_source( knowledge_base_id="KB123", name="My Data Source", source_type="S3", bucket_arn="arn:aws:s3:::my-bucket" )

# 特定のプレフィックスのみを含めるデータソース
create_data_source(
    knowledge_base_id="KB123",
    name="Documents Only",
    source_type="S3",
    bucket_arn="arn:aws:s3:::my-bucket",
    inclusion_prefixes="documents/,pdfs/"
)

# カスタムパーシングとチャンキング設定を使用
create_data_source(
    knowledge_base_id="KB123",
    name="Custom Data Source",
    source_type="S3",
    bucket_arn="arn:aws:s3:::my-bucket",
    parsing_strategy="BEDROCK_FOUNDATION_MODEL",
    parsing_model_arn="arn:aws:bedrock:us-east-1::foundation-model/anthropic.claude-3-sonnet-20240229-v1:0",
    parsing_modality="MULTIMODAL",
    chunking_strategy="FIXED_SIZE",
    chunking_max_tokens=1000,
    chunking_overlap_percentage=20
)

新しいAmazon Bedrock Knowledge Baseを作成します。

Args: name: Knowledge Baseの名前（1-100文字） description: Knowledge Baseの説明（1文字以上） role_arn: Knowledge Baseが使用するIAMロールのARN - 完全な形式: "arn:aws:iam::ACCOUNT_ID:role/ROLE_NAME" - アカウントIDなし: "arn:aws:iam::role/ROLE_NAME" または "role/ROLE_NAME"（自動補完） storage_type: ストレージタイプ - 'S3': 標準的なS3ストレージ（デフォルト） - 'S3_VECTORS': S3 Vectorsを使用したベクトル検索対応ストレージ bucket_arn: ドキュメントを保存するS3バケットのARNまたはS3 URI - ARN形式: "arn:aws:s3:::BUCKET_NAME" - URI形式: "s3://BUCKET_NAME" または "s3://BUCKET_NAME/path" S3_VECTORSの場合はベクトルバケットARNまたはURIを指定 region: Knowledge Baseを作成する先のリージョン（デフォルト: "us-east-1"） 例: "us-east-1", "ap-northeast-1" 注意: Knowledge Baseのリージョンは作成時に決定され、後から変更できません embedding_model_arn: 埋め込みモデルのARN（S3_VECTORSタイプの場合必須） 形式: "arn:aws:bedrock:REGION::foundation-model/MODEL_ID"

    サポートされている埋め込みモデル:
    - Amazon Titan Embeddings G1 - Text:
      "arn:aws:bedrock:REGION::foundation-model/amazon.titan-embed-text-v1"
      （ベクトル次元数: 1536、タイプ: Floating-point）
    
    - Amazon Titan Text Embeddings V2:
      "arn:aws:bedrock:REGION::foundation-model/amazon.titan-embed-text-v2:0"
      （ベクトル次元数: 256, 512, 1024、タイプ: Floating-point, binary）
    
    - Cohere Embed Multilingual:
      "arn:aws:bedrock:REGION::foundation-model/cohere.embed-multilingual-v3"
      （ベクトル次元数: 1024、タイプ: Floating-point, binary）
    
    - Amazon Nova Multimodal Embeddings v1:
      "arn:aws:bedrock:REGION::foundation-model/amazon.nova-2-multimodal-embeddings-v1:0"
      （ベクトル次元数: 1024、タイプ: Floating-point）
      （マルチモーダル対応: テキスト、画像、動画、音声を処理可能）
      注意: マルチモーダルコンテンツを処理する場合は、supplementalDataStorageConfiguration
      でマルチモーダルストレージ先を指定する必要があります
    
    例: "arn:aws:bedrock:us-east-1::foundation-model/amazon.titan-embed-text-v1"
    注意: リージョンは実際に使用するリージョンに置き換えてください

パーシング設定（オプション）:
parsing_strategy: パーシング戦略
    - 'BEDROCK_FOUNDATION_MODEL': Foundation Modelを使用したパーシング
      （マルチモーダルデータ（画像、表、グラフなど）を処理可能、プロンプトカスタマイズ可能）
    - 'BEDROCK_DATA_AUTOMATION': Bedrock Data Automationを使用したパーシング
      （マルチモーダルデータを処理可能、完全マネージド、追加プロンプト不要）
    注意: 指定しない場合はデフォルトパーサーが使用されます（テキストのみ、無料）
parsing_model_arn: Foundation ModelのARN（parsing_strategy='BEDROCK_FOUNDATION_MODEL'の場合必須）
    例: "arn:aws:bedrock:us-east-1::foundation-model/anthropic.claude-3-sonnet-20240229-v1:0"
    サポートされているモデル: Claude 3 Sonnet, Claude 3 Opus, Claude 3 Haikuなど
parsing_modality: マルチモーダル設定
    - 'MULTIMODAL': テキストと画像の両方を処理（オプション）
parsing_prompt_text: パーシングプロンプトのテキスト（オプション）
    Foundation Modelにドキュメントの解釈方法を指示するテキスト
    例: "Extract all text, tables, and figures from this document."

チャンキング設定（オプション）:
chunking_strategy: チャンキング戦略
    - 'FIXED_SIZE': 固定サイズのチャンクに分割（推奨: max_tokens=1000, overlap_percentage=20）
    - 'HIERARCHICAL': 階層的なチャンクに分割（大きなチャンクと小さなチャンクの2層）
    - 'SEMANTIC': セマンティックなチャンクに分割（NLPを使用して類似コンテンツでグループ化）
    - 'NONE': チャンクに分割しない（各ファイルが1つのチャンクとして扱われる）
    注意: 指定しない場合はデフォルトのチャンキングが使用されます
chunking_max_tokens: 最大トークン数（chunking_strategy='FIXED_SIZE'または'SEMANTIC'の場合に使用）
    - FIXED_SIZE: 1以上（推奨: 500-2000）
    - SEMANTIC: 1以上（推奨: 1000-3000）
chunking_overlap_percentage: オーバーラップ率（chunking_strategy='FIXED_SIZE'の場合に使用）
    範囲: 1-99（推奨: 10-30）
    隣接するチャンク間で重複するトークンの割合
chunking_overlap_tokens: オーバーラップトークン数（chunking_strategy='HIERARCHICAL'の場合に使用）
    階層チャンキングで使用する重複トークン数
chunking_buffer_size: バッファサイズ（chunking_strategy='SEMANTIC'の場合に使用）
    範囲: 0-1（推奨: 1）
    文を比較する際の移動コンテキストウィンドウのサイズ
chunking_breakpoint_threshold: ブレークポイントのパーセンタイル閾値（chunking_strategy='SEMANTIC'の場合に使用）
    範囲: 50-99（推奨: 80-95）
    チャンクを分割するための類似度閾値（低いほど多くのチャンクが作成される）

Returns: KnowledgeBaseResponseDict: Knowledge Baseの作成結果 - knowledge_base_id: 作成されたKnowledge BaseのID - status: Knowledge Baseのステータス（'CREATING', 'ACTIVE', 'FAILED'など） - arn: Knowledge BaseのARN（オプション）

Raises: ValueError: 入力値が無効な場合（バリデーションエラー） - storage_typeが無効な値の場合 - S3_VECTORSタイプでembedding_model_arnが指定されていない場合 - parsing_strategy='BEDROCK_FOUNDATION_MODEL'でparsing_model_arnが指定されていない場合 - ARN形式が無効な場合

Examples: # 基本的なKnowledge Baseの作成（デフォルト設定） create_knowledge_base( name="My Knowledge Base", description="Example KB", role_arn="arn:aws:iam::123456789012:role/BedrockKBRole", storage_type="S3", bucket_arn="s3://my-bucket" # S3 URI形式も使用可能 )

# S3 Vectorsを使用したKnowledge Baseの作成
create_knowledge_base(
    name="Vector KB",
    description="Vector search enabled KB",
    role_arn="role/BedrockKBRole",  # アカウントIDなし形式も使用可能（自動補完）
    storage_type="S3_VECTORS",
    bucket_arn="s3://vector-bucket",  # S3 URI形式も使用可能
    embedding_model_arn="arn:aws:bedrock:us-east-1::foundation-model/amazon.titan-embed-text-v1"
)

# カスタムパーシングとチャンキング設定を使用
create_knowledge_base(
    name="Custom KB",
    description="KB with custom parsing and chunking",
    role_arn="arn:aws:iam::123456789012:role/BedrockKBRole",
    storage_type="S3",
    bucket_arn="arn:aws:s3:::my-bucket",
    parsing_strategy="BEDROCK_FOUNDATION_MODEL",
    parsing_model_arn="arn:aws:bedrock:us-east-1::foundation-model/anthropic.claude-3-sonnet-20240229-v1:0",
    parsing_modality="MULTIMODAL",
    chunking_strategy="FIXED_SIZE",
    chunking_max_tokens=1000,
    chunking_overlap_percentage=20
)

# Amazon Nova Multimodal Embeddings v1を使用したマルチモーダルKnowledge Base
create_knowledge_base(
    name="Multimodal KB",
    description="KB with Nova Multimodal Embeddings",
    role_arn="arn:aws:iam::123456789012:role/BedrockKBRole",
    storage_type="S3_VECTORS",
    bucket_arn="arn:aws:s3:::vector-bucket",
    embedding_model_arn="arn:aws:bedrock:us-east-1::foundation-model/amazon.nova-2-multimodal-embeddings-v1:0",
    multimodal_storage_s3_uri="s3://multimodal-storage-bucket/"
)

S3バケットを新規作成します。

バケット名は以下のルールに従う必要があります:

• 3文字以上63文字以下

• 小文字、数字、ハイフン（-）、ピリオド（.）のみ使用可能

• 先頭と末尾は小文字または数字である必要がある

• 連続するハイフンやピリオドは使用不可

• IPアドレス形式（例: 192.168.1.1）は使用不可

• バケット名はグローバルに一意である必要があります

注意: セキュリティ上の理由から、パブリックアクセスブロックは常に有効化されます。

Args: bucket_name: 作成するS3バケット名（必須） 例: "my-documents-bucket" region: バケットを作成するリージョン（デフォルト: "us-east-1"） 例: "us-east-1", "ap-northeast-1" 注意: us-east-1リージョンの場合、LocationConstraintは指定しません

Returns: S3BucketCreateResponseDict: バケット作成結果 - bucket_name: 作成されたバケット名 - region: バケットが作成されたリージョン - arn: バケットのARN（arn:aws:s3:::bucket-name形式） - status: 作成ステータス（"created"）

Raises: ValueError: bucket_nameが空の場合、またはバケット名が無効な形式の場合 ClientError: AWS API呼び出しが失敗した場合 例: バケット名が既に使用されている、権限がないなど

Example: # 基本的なバケット作成（デフォルトリージョン、パブリックアクセスブロック有効） create_s3_bucket("my-documents-bucket")

# 特定のリージョンにバケットを作成
create_s3_bucket("my-documents-bucket", region="ap-northeast-1")

Note: - バケットの作成には数秒かかる場合があります - バケット名が既に使用されている場合、BucketAlreadyOwnedByYouまたはBucketAlreadyExistsエラーが発生します - パブリックアクセスブロック設定は、バケット作成後に自動的に適用されます

取り込みジョブのステータスと詳細情報を取得します。

取り込みジョブの進捗状況、統計情報、エラー情報などを取得できます。

Args: knowledge_base_id: Knowledge BaseのID data_source_id: データソースのID ingestion_job_id: 取り込みジョブのID（start_ingestion_jobで取得）

Returns: IngestionJobResponseDict: 取り込みジョブの詳細情報 - ingestion_job_id: 取り込みジョブのID - status: ジョブのステータス - "STARTING": ジョブが開始中 - "IN_PROGRESS": ジョブが実行中 - "COMPLETE": ジョブが完了 - "FAILED": ジョブが失敗 - statistics: 統計情報（オプション、ジョブが進行中または完了している場合） - numberOfDocumentsScanned: スキャンされたドキュメント数 - numberOfDocumentsModified: 変更されたドキュメント数 - numberOfDocumentsDeleted: 削除されたドキュメント数 - numberOfDocumentsFailed: 失敗したドキュメント数

Raises: ValueError: いずれかのIDが空の場合

特定のAmazon Bedrock Knowledge Baseの詳細情報を取得します。

Args: knowledge_base_id: Knowledge BaseのID

Returns: KnowledgeBaseDetailDict: Knowledge Baseの詳細情報 - id: Knowledge BaseのID - name: Knowledge Baseの名前 - status: Knowledge Baseのステータス - description: Knowledge Baseの説明（オプション） - arn: Knowledge BaseのARN（オプション） - その他の設定情報

Raises: ValueError: knowledge_base_idが空の場合

指定されたKnowledge Baseのデータソース一覧を取得します。

Knowledge Baseに紐づけられているすべてのデータソースを取得します。

Args: knowledge_base_id: Knowledge BaseのID

Returns: DataSourceListResponseDict: データソース一覧 - count: データソースの数 - data_sources: データソースの詳細情報のリスト 各要素には以下の情報が含まれます: - id: データソースのID - name: データソースの名前 - status: データソースのステータス - dataSourceConfiguration: データソースの設定情報

Raises: ValueError: knowledge_base_idが空の場合

すべてのAmazon Bedrock Knowledge Baseの一覧を取得します。

Returns: KnowledgeBaseListResponseDict: Knowledge Base一覧 - count: Knowledge Baseの数 - knowledge_bases: Knowledge Baseの詳細情報のリスト

S3バケット内のドキュメント一覧を取得します。

指定されたプレフィックス（フォルダ）に一致するドキュメントのみを 取得することもできます。

Args: bucket_name: S3バケット名 prefix: フィルタリングするS3プレフィックス（オプション） 例: "documents/" を指定すると、documents/フォルダ内の ファイルのみが返されます

Returns: S3DocumentListResponseDict: ドキュメント一覧 - count: ドキュメントの数 - bucket: バケット名 - prefix: 使用されたプレフィックス（指定した場合） - documents: ドキュメントの詳細情報のリスト 各要素には以下の情報が含まれます: - key: S3オブジェクトキー（ファイルパス） - size: ファイルサイズ（バイト） - last_modified: 最終更新日時（ISO形式）

Raises: ValueError: bucket_nameが空の場合

Example: # すべてのドキュメントを取得 list_s3_documents("my-bucket")

# 特定のプレフィックスのドキュメントのみを取得
list_s3_documents("my-bucket", "documents/")

Knowledge Baseに対してRAG（Retrieval-Augmented Generation）クエリを実行します。

ベクトル検索を使用して、クエリに関連するドキュメントを取得します。

Args: knowledge_base_id: クエリ対象のKnowledge BaseのID query: 検索クエリのテキスト number_of_results: 返す結果の数（デフォルト: 5、範囲: 1-100）

Returns: RetrieveResponseDict: クエリ結果 - results: 検索結果のリスト（各結果にはcontent、location、score、metadataが含まれる） - query: 実行したクエリテキスト

Raises: ValueError: 入力値が無効な場合（knowledge_base_idやqueryが空、number_of_resultsが範囲外など）

データソースからKnowledge Baseへのデータ取り込みジョブを開始します。

このジョブは非同期で実行され、データソース内のドキュメントを Knowledge Baseに取り込みます。ジョブの進捗はget_ingestion_jobで確認できます。

Args: knowledge_base_id: Knowledge BaseのID data_source_id: データソースのID

Returns: IngestionJobResponseDict: 取り込みジョブの開始結果 - ingestion_job_id: 開始された取り込みジョブのID - status: ジョブのステータス（通常は "STARTING" または "IN_PROGRESS"） - statistics: 統計情報（オプション、ジョブ開始時は通常None）

Raises: ValueError: knowledge_base_idまたはdata_source_idが空の場合

Note: 取り込みジョブは非同期で実行されるため、この関数は即座に返ります。 ジョブの完了を待つには、get_ingestion_jobを定期的に呼び出して ステータスを確認してください。

Amazon Bedrock Knowledge Baseを更新します。

Knowledge Baseの名前、説明、IAMロールを更新できます。 空文字列のパラメータは更新されません（既存の値が保持されます）。

Args: knowledge_base_id: 更新対象のKnowledge BaseのID name: 新しい名前（オプション、空文字列の場合は更新されない） description: 新しい説明（オプション、空文字列の場合は更新されない） role_arn: 新しいIAMロールARN（オプション、空文字列の場合は更新されない）

Returns: KnowledgeBaseResponseDict: 更新されたKnowledge Baseのステータス - knowledge_base_id: Knowledge BaseのID - status: Knowledge Baseのステータス - arn: Knowledge BaseのARN（オプション）

Raises: ValueError: knowledge_base_idが空の場合

ローカルファイルをS3バケットにアップロードします。

アップロードされたファイルは、Knowledge Baseのデータソースとして 使用できます。

Args: local_file_path: アップロードするローカルファイルのパス bucket_name: アップロード先のS3バケット名 s3_key: S3オブジェクトキー（バケット内のパス） 例: "documents/myfile.pdf" のようにパスを指定可能

Returns: S3UploadResponseDict: アップロード結果 - s3_uri: アップロードされたファイルのS3 URI（s3://bucket/key形式） - status: アップロードステータス（"uploaded"）

Raises: ValueError: パラメータが空の場合、またはファイルが存在しない場合

Example: upload_document_to_s3( "/path/to/document.pdf", "my-bucket", "documents/document.pdf" ) # 戻り値: {"s3_uri": "s3://my-bucket/documents/document.pdf", "status": "uploaded"}