View a markdown version of this page

Confluence データソースを接続する - Amazon Bedrock

翻訳は機械翻訳により提供されています。提供された翻訳内容と英語版の間で齟齬、不一致または矛盾がある場合、英語版が優先します。

Confluence データソースを接続する

認証を設定し、認証情報を AWS Secrets Manager シークレットに保存したら、ナレッジベースに Confluence データソースを作成します。このページでは、 AWS マネジメントコンソール または API を使用してデータソースを作成し、次に設定できるコネクタパラメータのリファレンスを作成する方法について説明します。

注記

最初に認証のセットアップを完了します。「Confluence の基本認証を設定する」または「Confluence の OAuth 2.0 認証を設定する」を参照してください。シークレット ARN と Confluence ホスト URL が必要です。

データソースを作成する

Console
Confluence をマネージドナレッジベースに接続するには
  1. データソースで、データソースの名前を指定します。

  2. データソースドロップダウンから Confluence を選択します。

  3. Source に Confluence URL を入力します (例: https://example.atlassian.net)。

  4. 「認証」で、基本認証または OAuth 2.0 認証を選択します。

  5. 認証情報を保存する AWS Secrets Manager シークレットを選択または作成します。

  6. (オプション、基本認証のみ) ドキュメントレベルのアクセスコントロールを有効にするには、ACLs を使用してドキュメントアクセスを制御するを選択します。選択したシークレットには、adminApiKeyorganizationId、および が含まれている必要がありますdirectoryId。このオプションは、作成後に変更することはできません。詳細については、「ドキュメントレベルのアクセスコントロール」を参照してください。

  7. (オプション) 同期スコープを展開して、クロールするエンティティタイプ (ページ、ブログ、ページアタッチメント、ブログアタッチメント、アーカイブスペース、アーカイブページ、個人スペース) を選択します。

  8. (オプション) エンティティ URLs を展開して、URL ベースのフィルタリングを使用して特定の Confluence スペース、ページ、ブログを同期します。

  9. (オプション) Mime タイプの正規表現パターンを展開して、特定の MIME タイプを含めるか除外します。

API

Confluence データソースを作成するには、Amazon Bedrock エージェントのビルドタイムエンドポイントを使用して CreateDataSource リクエストを送信します。次の AWS Command Line Interface 例では、基本認証を使用するデータソースを作成します。代わりに OAuth 2.0 を使用するには、 authTypeを に変更しますOAUTH2。ドキュメントレベルのアクセスコントロールを有効にするには、 aclEnabledを に設定しますtrue。各フィールドの説明については、以下のコネクタパラメータリファレンスを参照してください。

aws bedrock-agent create-data-source \ --name "Confluence-connector" \ --knowledge-base-id "your-knowledge-base-id" \ --data-source-configuration file://confluence-managed-connector.json

confluence-managed-connector.json ファイルには以下が含まれています。

{ "type": "MANAGED_KNOWLEDGE_BASE_CONNECTOR", "managedKnowledgeBaseConnectorConfiguration": { "connectorParameters": { "type": "CONFLUENCE", "version": "1", "aclEnabled": false, "connectionConfiguration": { "secretArn": "arn:aws:secretsmanager:us-west-2:123456789012:secret:bedrock-confluence-basic-creds", "type": "SAAS", "authType": "BASIC", "hostUrl": "https://example.atlassian.net" }, "dataEntityConfiguration": { "crawlPage": true, "crawlBlog": true, "crawlPageAttachment": true, "crawlBlogAttachment": true }, "filterConfiguration": { "inclusionSpaceKeys": ["ENG", "DOCS"] } } } }

マネージドナレッジベースの場合、 CreateDataSourceは非同期です。オペレーションが完了すると、データソースのステータスは から CREATING に移行AVAILABLEします。

コネクタパラメータ

データソース設定では、次のコネクタパラメータを使用します。Confluence に接続するには、 でコネクタタイプCONFLUENCEとして を指定しますconnectorParameters。ラップするフィールド connectorParameters ( deletionProtectionConfigurationや などmediaExtractionConfiguration) については、「」を参照してくださいデータソースを接続する

aclEnabled 明示的に を設定する

を省略した場合aclEnabled、デフォルトは に依存しますauthTypeBASICデフォルトは trueOAUTH2デフォルトは ですfalse。データソースの作成後は ACL 設定が永続的であるため、データソースが意図したアクセスコントロール動作を持つようにaclEnabled明示的に を設定します。詳細については、「ドキュメントレベルのアクセスコントロール」を参照してください。

connectionConfiguration
フィールド 必要 説明
secretArn はい Confluence 認証情報を含む AWS Secrets Manager シークレットの ARN。
type はい Confluence デプロイタイプ。SAAS に設定します。Confluence Server とデータセンターはサポートされていません。
authType はい 認証タイプ を BASICまたは に設定しますOAUTH2。「認証方法」を参照してください。
hostUrl はい Confluence Cloud インスタンスのベース URL (例: https://example.atlassian.net)。
dataEntityConfiguration (オプション)
フィールド 必要 説明
crawlPage いいえ ページをクロールするかどうか。
crawlBlog いいえ ブログ投稿をクロールするかどうか。
crawlPageAttachment いいえ ページの添付ファイルをクロールするかどうか。crawlPage が でもある場合にのみクロールされますtrue
crawlBlogAttachment いいえ ブログ投稿の添付ファイルをクロールするかどうか。crawlBlog が でもある場合にのみクロールされますtrue
crawlArchivedSpace いいえ アーカイブされたスペースをクロールするかどうか。
crawlArchivedPage いいえ アーカイブされたページをクロールするかどうか。
crawlPersonalSpace いいえ 個人用スペースをクロールするかどうか。
filterConfiguration (オプション)
フィールド 必要 説明
inclusionSpaceKeys いいえ 含めるスペースキー。
inclusionSpaceUrls いいえ 含めURLs。
inclusionMimeTypes いいえ 含める MIME タイプ。
exclusionMimeTypes いいえ 除外する MIME タイプ。
maxFileSizeInMegaBytes いいえ コネクタが取り込む 1 つのファイルの最大サイズ、メガバイト単位。数値文字列として を指定します (例: "500")。デフォルトは "500" です。
aclEnabled (オプション)
フィールド 必要 説明
aclEnabled いいえ ドキュメントレベルのアクセスコントロールが有効になっているかどうか。を有効にするtrueには を、無効にfalseするには に設定します。このフィールドを省略した場合、デフォルトは によって異なりますauthTypeBASICデフォルトは 、trueOAUTH2デフォルトは ですfalse。の ACL には、Atlassian 組織の管理者認証情報を含むシークレットBASICが必要です。データソースの作成後にこの設定を変更することはできません。詳細については、「ドキュメントレベルのアクセスコントロール」を参照してください。

認証方法を変更する

UpdateDataSource オペレーションまたは を使用して、データソースの認証方法 (OAuth 2.0 から Basic など) を変更するには、データソースを新しい authTypeと、一致する認証情報を含むシークレットで更新します AWS マネジメントコンソール。ドキュメントレベルのアクセスコントロール設定は、データソースの作成時に修正されるため、ACLs を追加または削除するには、新しいデータソースを作成する必要があります。

次の手順

データソースを作成したら、同期してコンテンツをナレッジベースに取り込みます。詳細については、「データソースを同期する」を参照してください。ユーザーアクセス許可でクエリ結果をフィルタリングするには、「」を参照してくださいドキュメントレベルのアクセスコントロール