View a markdown version of this page

Verbindung zu Confluence für die Wissensdatenbank - Amazon Bedrock

Die vorliegende Übersetzung wurde maschinell erstellt. Im Falle eines Konflikts oder eines Widerspruchs zwischen dieser übersetzten Fassung und der englischen Fassung (einschließlich infolge von Verzögerungen bei der Übersetzung) ist die englische Fassung maßgeblich.

Verbindung zu Confluence für die Wissensdatenbank

Atlassian Confluence ist ein zusammenarbeitsorientiertes Arbeitsmanagement-Tool zum Freigeben, Speichern und Arbeiten an Projektplanung, Softwareentwicklung und Produktmanagement. Sie können eine Verbindung zu Ihrer Confluence-Instance für Ihre Amazon Bedrock-Wissensdatenbank herstellen, indem Sie entweder die AWS Management Console für Amazon Bedrock oder die CreateDataSourceAPI verwenden (siehe von Amazon Bedrock unterstützte SDKs und). AWS CLI

Anmerkung

Beim Datenquellen-Connector Confluence handelt es sich um eine Vorversion, bei der Änderungen vorbehalten sind.

Confluence-Datenquellen unterstützen keine multimodalen Daten wie Tabellen, Diagramme, Diagramme oder andere Bilder.

Amazon Bedrock unterstützt die Verbindung zu Confluence-Cloud-Instances. Derzeit ist nur Amazon OpenSearch Serverless Vector Store für die Verwendung mit dieser Datenquelle verfügbar.

Anzahl und Größe der durchsuchbaren Dateien sind beschränkt. Weitere Informationen finden Sie unter Kontingente für Wissensdatenbanken.

Unterstützte Features

  • Automatische Erkennung der wichtigsten Dokumentfelder

  • Inclusion/exclusion Inhaltsfilter

  • Inkrementelle Inhaltssynchronisierung für hinzugefügte, aktualisierte und gelöschte Inhalte

  • OAuth-2.0-Authentifizierung, Authentifizierung mit Confluence-API-Token

Voraussetzungen

Stellen Sie in Confluence Folgendes sicher:

  • Notieren Sie die URL der Confluence-Instance. Zum Beispiel für Confluence Cloud,. https://example.atlassian.net Die URL für Confluence Cloud muss die Basis-URL sein und mit enden. .atlassian.net

  • Konfigurieren Sie grundlegende Anmeldeinformationen für die Authentifizierung, die einen Benutzernamen (E-Mail des Administratorkontos) und ein Passwort (Confluence-API-Token) enthalten, sodass eine Verbindung zwischen Amazon Bedrock und Ihrer Confluence Cloud-Instance hergestellt werden kann. Informationen zum Erstellen eines Confluence-API-Tokens finden Sie auf der Atlassian-Website unter API-Token für Ihr Atlassian-Konto verwalten.

  • (Optional) Konfigurieren Sie eine OAuth 2.0-Anwendung mit den Anmeldeinformationen eines App-Schlüssels, eines geheimen App-Schlüssels, eines Zugriffstokens und eines Aktualisierungstokens. Weitere Informationen finden Sie unter OAuth-2.0-Apps auf der Atlassian-Website.

  • Es müssen bestimmte Leseberechtigungen oder Bereiche aktiviert sein, damit eine Verbindung zwischen der OAuth 2.0-App und Confluence möglich wird.

    Confluence-API:

    • offline_access

    • read:content:confluence – Detaillierte Inhalte anzeigen

    • read:content:confluence – Inhaltsdetails anzeigen

    • read:space-details:confluence – Bereichsdetails anzeigen

    • read:audit-log:confluence – Audit-Aufzeichnungen anzeigen

    • read:page:confluence – Seiten anzeigen

    • read:attachment:confluence – Inhaltsanhänge ansehen und herunterladen

    • read:blogpost:confluence – Blogbeiträge ansehen

    • read:custom-content:confluence – Benutzerdefinierten Inhalt anzeigen

    • read:comment:confluence – Kommentare anzeigen

    • read:template:confluence – Inhaltsvorlagen anzeigen

    • read:label:confluence – Labels anzeigen

    • read:watcher:confluence – Inhaltsbeobachter anzeigen

    • read:relation:confluence – Entitätsbeziehungen anzeigen

    • read:user:confluence – Benutzerdetails anzeigen

    • read:configuration:confluence – Confluence-Einstellungen anzeigen

    • read:space-details:confluence – Bereichsdetails anzeigen

    • read:space.property:confluence – Bereichseigenschaften anzeigen

    • read:user.property:confluence – Benutzereigenschaften anzeigen

    • read:space.setting:confluence – Bereichseinstellungen anzeigen

    • read:analytics.content:confluence – Analytik für Inhalte anzeigen

    • read:content.property:confluence – Inhaltseigenschaften anzeigen

    • read:content.metadata:confluence – Inhaltszusammenfassungen anzeigen

    • read:inlinetask:confluence – Aufgaben anzeigen

    • read:task:confluence – Aufgaben anzeigen

    • read:whiteboard:confluence – Whiteboards anzeigen

    • read:app-data:confluence – App-Daten lesen

    • read:folder:confluence – Ordner anzeigen

    • read:embed:confluence – Smart-Link-Daten anzeigen

Stellen Sie in Ihrem AWS Konto sicher, dass Sie:

  • Speichern Sie Ihre Anmeldeinformationen für die Authentifizierung in einem AWS Secrets Manager -Secret und notieren Sie sich dessen Amazon-Ressourcennamen (ARN). Folgen Sie den Anweisungen zur Verbindungskonfiguration auf dieser Seite, um die Schlüssel-Wert-Paare aufzunehmen, die in Ihrem Secret enthalten sein müssen.

  • Nehmen Sie die erforderlichen Berechtigungen für die Verbindung mit Ihrer Datenquelle in Ihre AWS Identity and Access Management (IAM) role/permissions -Richtlinie für Ihre Wissensdatenbank auf. Informationen zu den erforderlichen Berechtigungen für diese Datenquelle, um sie Ihrer IAM Wissensdatenbank-Rolle hinzuzufügen, finden Sie unter Berechtigungen für den Zugriff auf Datenquellen.

Anmerkung

Wenn Sie die Konsole verwenden, können Sie Ihr Geheimnis AWS Secrets Manager hinzufügen oder ein vorhandenes Geheimnis als Teil des Konfigurationsschritts für die Datenquelle verwenden. Die IAM Rolle mit allen erforderlichen Berechtigungen kann im Rahmen der Konsolenschritte zum Erstellen einer Wissensdatenbank für Sie erstellt werden. Nachdem Sie Ihre Datenquelle und andere Konfigurationen konfiguriert haben, wird die IAM Rolle mit allen erforderlichen Berechtigungen auf Ihre spezifische Wissensdatenbank angewendet.

Wir empfehlen, die Anmeldeinformationen und Secrets regelmäßig zu aktualisieren oder zu wechseln. Stellen Sie zu Ihrer eigenen Sicherheit nur die unbedingt erforderliche Zugriffsebene bereit. Wir raten davon ab, für mehrere Datenquellen identische Anmeldeinformationen und Secrets zu verwenden.

Konfiguration der Verbindung

Um eine Verbindung zur Confluence-Instance herzustellen, müssen Sie die erforderlichen Konfigurationsinformationen angeben, damit Amazon Bedrock auf Ihre Daten zugreifen und nach ihnen suchen kann. Befolgen Sie zudem Voraussetzungen.

Ein Beispiel für eine Konfiguration für diese Datenquelle ist in diesem Abschnitt enthalten.

Weitere Informationen zur auto Erkennung von Dokumentfeldern, inclusion/exclusion Filtern, inkrementeller Synchronisierung, geheimen Authentifizierungsdaten und deren Funktionsweise finden Sie unter:

Der Datenquellen-Connector erkennt und durchsucht automatisch alle wichtigen Metadatenfelder von Dokumenten oder Inhalten. Der Datenquellen-Connector kann beispielsweise den Dokumenttext zu den Dokumenten, den Dokumenttitel, das Erstellungs- oder Änderungsdatum des Dokuments oder andere Kernfelder durchsuchen, die für die Dokumente gelten.

Wichtig

Wenn Ihr Inhalt vertrauliche Informationen enthält, Amazon Bedrock könnten Sie mit vertraulichen Informationen antworten.

Sie können Filteroperatoren auf Metadatenfelder anwenden, um die Relevanz von Antworten weiter zu verbessern. Zum Beispiel: Dokument „epoch_modification_time“ oder die Anzahl der Sekunden, die seit dem 1. Januar 1970 vergangen sind, als das Dokument zuletzt aktualisiert wurde. Sie können nach den neuesten Daten filtern, wobei „epoch_modification_time“ größer als eine bestimmte Zahl ist. Weitere Informationen zu den Filteroperatoren, die Sie auf die Metadatenfelder anwenden können, finden Sie unter Metadaten und Filterung.

Sie können das Crawling bestimmter Inhalte ein- oder ausschließen. Sie können beispielsweise ein prefix/regular Ausschlussausdrucksmuster angeben, um das Crawlen von Dateien zu überspringen, deren Dateiname „privat“ enthält. Sie können auch ein Muster für prefix/regular Einschlussausdrücke angeben, um bestimmte Inhaltsentitäten oder Inhaltstypen einzubeziehen. Wenn Sie einen Ein- und einen Ausschlussfilter angeben und beide auf ein Dokument zutreffen, hat der Ausschlussfilter Vorrang und das Dokument wird nicht durchsucht.

Ein Beispiel für ein Muster für reguläre Ausdrücke zum Ausschließen oder Herausfiltern von PDF-Dateien, deren Dateiname das Wort „privat“ enthält: ".*privat.*\\.pdf"

Sie können inclusion/exclusion Filter auf die folgenden Inhaltstypen anwenden:

  • Space: Einzelnes Leerzeichen

  • Page: Haupttitel der Seite

  • Blog: Haupttitel des Blogs

  • Comment: Kommentare, die zu einer bestimmten Seite oder einem bestimmten Blog gehören. Angeben der Re: Page/Blog Title

  • Attachment: Name der Anhangsdatei mit Erweiterung

Der Datenquellen-Connector crawlt neue, geänderte und gelöschte Inhalte jedes Mal, wenn Ihre Datenquelle mit Ihrer Wissensdatenbank synchronisiert wird. Amazon Bedrock kann den Mechanismus Ihrer Datenquelle verwenden, um Inhaltsänderungen nachzuverfolgen und Inhalte zu crawlen, die sich seit der letzten Synchronisierung geändert haben. Wenn Sie die Datenquelle zum ersten Mal mit der Wissensdatenbank synchronisieren, werden standardmäßig alle Inhalte synchronisiert.

Um Ihre Datenquelle mit Ihrer Wissensdatenbank zu synchronisieren, verwenden Sie die StartIngestionJobAPI oder wählen Sie Ihre Wissensdatenbank in der Konsole aus und wählen Sie im Bereich Datenquellenübersicht die Option Synchronisieren aus.

Wichtig

Alle Daten, die Sie aus der Datenquelle synchronisieren, stehen allen Personen mit der bedrock:Retrieve-Berechtigung zum Abrufen der Daten zur Verfügung. Dies kann auch alle Daten mit kontrollierten Datenquellenberechtigungen einschließen. Weitere Informationen finden Sie unter Berechtigungen für die Wissensdatenbank.

(Bei Verwendung der Standardauthentifizierung) Die Secret-Anmeldeinformationen für die Authentifizierung in AWS Secrets Manager sollten die folgenden Schlüssel-Wert-Paare enthalten:

  • username: admin user email address of Atlassian account

  • password: Confluence API token

(Bei Verwendung der OAuth-2.0-Authentifizierung) Die Secret-Anmeldeinformationen für die Authentifizierung in AWS Secrets Manager sollten die folgenden Schlüssel-Wert-Paare enthalten:

  • confluenceAppKey: app key

  • confluenceAppSecret: app secret

  • confluenceAccessToken: app access token

  • confluenceRefreshToken: app refresh token

Anmerkung

Das OAuth2.0 Confluence-Zugriffstoken hat eine Standardablaufzeit von 60 Minuten. Wenn dieses Token abläuft, während Ihre Datenquelle synchronisiert wird (Synchronisierungsauftrag), verwendet Amazon Bedrock das bereitgestellte Aktualisierungstoken, um dieses Token neu zu generieren. Bei dieser Regenerierung werden sowohl die Zugriffs- als auch die Aktualisierungstoken aktualisiert. Um die Token vom aktuellen Synchronisierungsauftrag bis zum nächsten Synchronisierungsauftrag auf dem neuesten Stand zu halten, benötigt Amazon Bedrock im Rahmen Ihrer IAM-Rolle in der Wissensdatenbank write/put Berechtigungen für Ihre geheimen Anmeldeinformationen.

Anmerkung

Ihr Secret in AWS Secrets Manager muss dieselbe Region wie Ihre Wissensdatenbank verwenden.

Console
Herstellen einer Verbindung zwischen Confluence-Instance und Wissensdatenbank
  1. Folgen Sie den Schritten unter So erstellen Sie eine Wissensdatenbank, indem Sie in Wissensdatenbanken für Amazon Bedrock eine Verbindung zu einer Datenquelle herstellen und wählen Sie Confluence als Datenquelle aus.

  2. Geben Sie den Namen und eine optionale Beschreibung für die Datenquelle an.

  3. Geben Sie die URL der Confluence-Instance an. Zum Beispiel für Confluence Cloud,. https://example.atlassian.net Die URL für Confluence Cloud muss die Basis-URL sein und mit enden. .atlassian.net

  4. Im Abschnitt Erweiterte Einstellungen können Sie optional Folgendes konfigurieren:

    • KMS-Schlüssel für den transienten Datenspeicher. — Sie können die transienten Daten verschlüsseln, während Sie Ihre Daten mit dem Standard Von AWS verwalteter Schlüssel - oder Ihrem eigenen KMS-Schlüssel in Einbettungen umwandeln. Weitere Informationen finden Sie unter Verschlüsselung der vorübergehenden Datenspeicherung während der Datenerfassung.

    • Richtlinie zum Löschen von Daten – Sie können die Vektoreinbettungen für die Datenquelle löschen, die standardmäßig im Vektorspeicher enthalten sind, oder die Vektorspeicherdaten beibehalten.

  5. Geben Sie die Authentifizierungsinformationen ein, um eine Verbindung zu Ihrer Confluence-Instance herzustellen:

    • Gehen Sie für die Standardauthentifizierung AWS Secrets Manager zu, um Ihre geheimen Authentifizierungsdaten hinzuzufügen, oder verwenden Sie einen vorhandenen Amazon-Ressourcennamen (ARN) für das von Ihnen erstellte Geheimnis. Ihr Secret muss die E-Mail-Adresse des Admin-Benutzers des Atlassian-Kontos als Benutzername und ein Confluence-API-Token anstelle eines Passworts enthalten. Informationen zum Erstellen eines Confluence-API-Tokens finden Sie auf der Atlassian-Website unter API-Token für Ihr Atlassian-Konto verwalten.

    • Gehen Sie für die OAuth 2.0-Authentifizierung zu, AWS Secrets Manager um Ihre geheimen Authentifizierungsdaten hinzuzufügen, oder verwenden Sie einen vorhandenen Amazon-Ressourcennamen (ARN) für das von Ihnen erstellte Geheimnis. Ihr Secret muss den Confluence-App-Schlüssel, das App-Secret, das Zugriffstoken und das Aktualisierungstoken enthalten. Weitere Informationen finden Sie unter OAuth-2.0-Apps auf der Atlassian-Website.

  6. (Optional) Im Abschnitt Parsing und Chunking von Inhalten können Sie anpassen, wie die Daten analysiert und aufgeteilt werden sollen. Werfen Sie einen Blick auf die folgenden Ressourcen, um mehr über diese Anpassungen zu erfahren:

  7. Wählen Sie, ob Sie filters/regular Ausdrucksmuster verwenden möchten, um bestimmte Inhalte ein- oder auszuschließen. Andernfalls werden alle Standardinhalte gecrawlt.

  8. Wählen Sie ein Einbettungsmodell und einen Vektorspeicher aus. Um die verbleibenden Schritte zu sehen, kehren Sie zu So erstellen Sie eine Wissensdatenbank, indem Sie in Wissensdatenbanken für Amazon Bedrock eine Verbindung zu einer Datenquelle herstellen zurück, nachdem Sie die Datenquelle verbunden haben, und fahren Sie mit diesem Schritt fort.

API

Im Folgenden finden Sie ein Beispiel für eine Konfiguration für die Verbindung mit Confluence Cloud für die Amazon-Bedrock-Wissensdatenbank. Sie konfigurieren Ihre Datenquelle mithilfe der API mit dem AWS CLI oder einem unterstützten SDK, z. B. Python. Nach dem Aufruf rufen Sie auf CreateKnowledgeBase, CreateDataSourceum Ihre Datenquelle mit Ihren Verbindungsinformationen zu erstellendataSourceConfiguration.

Weitere Informationen zu Anpassungen, die Sie auf die Erfassung anwenden können, indem Sie das optionale vectorIngestionConfiguration-Feld einbeziehen, finden Sie unter So passen Sie die Aufnahme für eine Datenquelle an.

AWS Command Line Interface

aws bedrock create-data-source \ --name "Confluence Cloud/SaaS connector" \ --description "Confluence Cloud/SaaS data source connector for Amazon Bedrock to use content in Confluence" \ --knowledge-base-id "your-knowledge-base-id" \ --data-source-configuration file://confluence-bedrock-connector-configuration.json \ --data-deletion-policy "DELETE" \ --vector-ingestion-configuration '{"chunkingConfiguration":[{"chunkingStrategy":"FIXED_SIZE","fixedSizeChunkingConfiguration":[{"maxTokens":"100","overlapPercentage":"10"}]}]}' confluence-bedrock-connector-configuration.json { "confluenceConfiguration": { "sourceConfiguration": { "hostUrl": "https://example.atlassian.net", "hostType": "SAAS", "authType": "OAUTH2_CLIENT_CREDENTIALS", "credentialsSecretArn": "arn:aws::secretsmanager:your-region:secret:AmazonBedrock-Confluence" }, "crawlerConfiguration": { "filterConfiguration": { "type": "PATTERN", "patternObjectFilter": { "filters": [ { "objectType": "Attachment", "inclusionFilters": [ ".*\\.pdf" ], "exclusionFilters": [ ".*private.*\\.pdf" ] } ] } } } }, "type": "CONFLUENCE" }