View a markdown version of this page

SharePoint Konnektor V1.0 - Amazon Kendra
Unterstützte FeaturesVoraussetzungenAnweisungen zur VerbindungWeitere Informationen

Amazon Kendra ist nicht mehr offen für neue Kunden. In den Amazon Bedrock Knowledge Bases finden Sie ähnliche Funktionen wie. Amazon KendraWeitere Informationen.

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.

SharePoint Konnektor V1.0

SharePoint ist ein kollaborativer Dienst zur Erstellung von Websites, mit dem Sie Webinhalte anpassen und Seiten, Websites, Dokumentbibliotheken und Listen erstellen können. Wenn Sie ein SharePoint Benutzer sind, können Sie ihn verwenden, Amazon Kendra um Ihre SharePoint Datenquelle zu indizieren.

Anmerkung

SharePoint Connector V1.0 / SharePointConfiguration API endete 2023. Wir empfehlen, zu SharePoint Connector V2.0 / TemplateConfiguration API zu migrieren oder ihn zu verwenden.

Informationen zur Fehlerbehebung bei Ihrem Amazon Kendra SharePoint Datenquellen-Connector finden Sie unterProblembehandlung bei Datenquellen.

Unterstützte Features

  • Feldzuordnungen

  • Zugriffskontrolle für Benutzer

  • Inclusion/exclusion Filter

  • Änderungsprotokoll

  • Virtual Private Cloud (VPC)

Voraussetzungen

Bevor Sie Ihre SharePoint Datenquelle Amazon Kendra zum Indizieren verwenden können, nehmen Sie diese Änderungen in Ihren SharePoint und AWS Konten vor.

Sie müssen Anmeldeinformationen angeben, die Sie sicher in einem AWS Secrets Manager geheimen Dokument speichern.

Anmerkung

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. Es wird nicht empfohlen, Anmeldeinformationen und Geheimnisse für alle Datenquellen und die Connector-Versionen 1.0 und 2.0 (sofern zutreffend) wiederzuverwenden.

Stellen Sie sicher SharePoint, dass Sie über Folgendes verfügen:

  • Haben Sie die URL der SharePoint Websites notiert, die Sie indizieren möchten.

  • Für SharePoint Online:

    • Haben Sie Ihre grundlegenden Anmeldeinformationen zur Authentifizierung notiert, die einen Benutzernamen und ein Passwort mit Administratorrechten für die Website enthalten.

    • Optional: Generierte OAuth 2.0-Anmeldeinformationen, die einen Benutzernamen, ein Passwort, eine Client-ID und einen geheimen Client-Schlüssel enthalten.

    • Sie haben Sicherheitsstandards in Ihrem Azure-Portal mit einem Administratorbenutzer deaktiviert. Weitere Informationen zur Verwaltung der Sicherheitsstandardeinstellungen im Azure-Portal finden Sie in der Microsoft-Dokumentation zum Umgang mit enable/disable Sicherheitsstandards.

  • Für SharePoint Server:

    • Notiert Ihren SharePoint Serverdomänennamen (den NetBIOS-Namen in Ihrem Active Directory). Sie verwenden ihn zusammen mit Ihrem Benutzernamen und Passwort für die SharePoint Standardauthentifizierung, um den Server mit dem SharePoint Server zu Amazon Kendra verbinden.

    Anmerkung

    Wenn Sie SharePoint Server verwenden und Ihre Zugriffskontrollliste (ACL) zum Filtern nach Benutzerkontext in das E-Mail-Format konvertieren müssen, geben Sie die LDAP-Server-URL und die LDAP-Suchbasis an. Oder Sie können die Verzeichnisdomänenüberschreibung verwenden. Die LDAP-Server-URL ist der vollständige Domainname und die Portnummer (z. B. ldap: //example.com:389). Die LDAP-Suchbasis sind die Domänencontroller 'example' und 'com'. Mit der Verzeichnisdomänenüberschreibung können Sie die E-Mail-Domain verwenden, anstatt die LDAP-Server-URL und die LDAP-Suchbasis zu verwenden. Die E-Mail-Domain für username@example.com lautet beispielsweise 'example.com'. Sie können diese Überschreibung verwenden, wenn Sie sich keine Gedanken über die Validierung Ihrer Domain machen und einfach Ihre E-Mail-Domain verwenden möchten.

  • Ihrem SharePoint Konto wurden die folgenden Berechtigungen hinzugefügt:

    Für SharePoint Listen

    • Elemente öffnen — Zeigen Sie die Quelle von Dokumenten mit serverseitigen Dateihandlern an.

    • Anwendungsseiten anzeigen — Zeigt Formulare, Ansichten und Anwendungsseiten an. Listen aufzählen.

    • Elemente anzeigen — Zeigt Elemente in Listen und Dokumenten in Dokumentbibliotheken an.

    • Versionen anzeigen — Zeigt frühere Versionen eines Listenelements oder Dokuments an.

    SharePoint Für Websites

    • Verzeichnisse durchsuchen — Zählen Sie Dateien und Ordner auf einer Website mithilfe von SharePoint Designer und der Web DAV-Oberfläche auf.

    • Benutzerinformationen durchsuchen — Zeigt Informationen über Benutzer der Website an.

    • Berechtigungen auflisten — Listet die Berechtigungen für die Website, die Liste, den Ordner, das Dokument oder das Listenelement auf.

    • Öffnen — Öffnet eine Website, eine Liste oder einen Ordner, um auf Elemente im Container zuzugreifen.

    • Funktionen zur Client-Integration verwenden — Verwenden Sie SOAP, WebDAV, das Client-Objektmodell oder SharePoint Designer-Schnittstellen, um auf die Website zuzugreifen.

    • Remote-Schnittstellen verwenden — Verwenden Sie Funktionen, mit denen Client-Anwendungen gestartet werden.

    • Seiten anzeigen — Zeigt Seiten auf einer Website an.

  • Aktiviert, jedes Dokument ist in SharePoint und zwischen anderen Datenquellen, die Sie für denselben Index verwenden möchten, einzigartig. Jede Datenquelle, die Sie für einen Index verwenden möchten, darf nicht in allen Datenquellen dasselbe Dokument enthalten. Dokument-IDs gelten global für einen Index und müssen pro Index eindeutig sein.

Stellen Sie in Ihrem sicher AWS-Konto, dass Sie:

  • Hat einen Amazon Kendra Index erstellt und bei Verwendung der API die Index-ID notiert.

  • Hat eine IAM Rolle für Ihre Datenquelle erstellt und, falls Sie die API verwenden, den ARN der IAM Rolle notiert.

    Anmerkung

    Wenn Sie Ihren Authentifizierungstyp und Ihre Anmeldeinformationen ändern, müssen Sie Ihre IAM Rolle aktualisieren, um auf die richtige AWS Secrets Manager geheime ID zuzugreifen.

  • Ihre Anmeldeinformationen für die SharePoint Authentifizierung wurden in einem AWS Secrets Manager Geheimnis gespeichert und, falls Sie die API verwenden, die ARN des Geheimnisses notiert.

    Anmerkung

    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 empfehlen nicht, Anmeldeinformationen und Geheimnisse für alle Datenquellen und die Connector-Versionen 1.0 und 2.0 (sofern zutreffend) wiederzuverwenden.

Wenn Sie noch keine IAM Rolle oder kein Geheimnis haben, können Sie die Konsole verwenden, um eine neue IAM Rolle und ein neues Secrets Manager Geheimnis zu erstellen, wenn Sie Ihre SharePoint Datenquelle mit verbinden. Amazon Kendra Wenn Sie die API verwenden, müssen Sie den ARN einer vorhandenen IAM Rolle und eines vorhandenen Secrets Manager Geheimnisses sowie eine Index-ID angeben.

Anweisungen zur Verbindung

Um eine Verbindung Amazon Kendra zu Ihrer SharePoint Datenquelle herzustellen, müssen Sie Angaben zu Ihren SharePoint Anmeldeinformationen machen, damit Sie auf Ihre Daten zugreifen Amazon Kendra können. Wenn Sie es noch nicht konfiguriert SharePoint haben, Amazon Kendra sieheVoraussetzungen.

Console

Um eine Verbindung Amazon Kendra herzustellen SharePoint

  1. Melden Sie sich bei der AWS Management Console an und öffnen Sie die Amazon Kendra Konsole.

  2. Wählen Sie im linken Navigationsbereich Indizes aus und wählen Sie dann den Index, den Sie verwenden möchten, aus der Liste der Indizes aus.

    Anmerkung

    Sie können Ihre Einstellungen für die Benutzerzugriffskontrolle unter Indexeinstellungen konfigurieren oder bearbeiten.

  3. Wählen Sie auf der Seite Erste Schritte die Option Datenquelle hinzufügen aus.

  4. Wählen Sie auf der Seite Datenquelle hinzufügen die Option SharePoint Connector v1.0 aus, und wählen Sie dann Datenquelle hinzufügen aus.

  5. Geben Sie auf der Seite „Datenquellendetails angeben“ die folgenden Informationen ein:

    1. Im Feld Name und Beschreibung für Datenquellenname — Geben Sie einen Namen für Ihre Datenquelle ein. Sie können Bindestriche, aber keine Leerzeichen verwenden.

    2. (Optional) Beschreibung — Geben Sie eine optionale Beschreibung für Ihre Datenquelle ein.

    3. In der Standardsprache — Wählen Sie eine Sprache aus, um Ihre Dokumente für den Index zu filtern. Sofern Sie nichts anderes angeben, ist die Standardsprache Englisch. Die in den Dokumentmetadaten angegebene Sprache überschreibt die ausgewählte Sprache.

    4. Im Feld Schlagworte für Neues Tag hinzufügen — Fügen Sie optionale Stichwörter hinzu, um Ihre Ressourcen zu durchsuchen und zu filtern oder Ihre Kosten zu verfolgen. AWS

    5. Wählen Sie Weiter aus.

  6. Geben Sie auf der Seite Zugriff und Sicherheit definieren die folgenden Informationen ein:

    1. Für die Hosting-Methode: Wählen Sie zwischen SharePoint Online und SharePoint Server.

      1. Für SharePoint Online — Geben Sie die für Ihr SharePoint Repository spezifischen Site-URLs ein.

      2. Für SharePoint Server — Wählen Sie Ihre SharePoint Version, geben Sie die für Ihr SharePoint Repository spezifischen Site-URLs ein und geben Sie den Amazon S3 Pfad zum Speicherort Ihres SSL-Zertifikats ein.

    2. (Nur SharePoint Server) Für Webproxy — Geben Sie den Hostnamen und die Portnummer Ihrer internen SharePoint Instance ein. Die Portnummer sollte ein numerischer Wert zwischen 0 und 65535 sein.

    3. Für die Authentifizierung — Wählen Sie je nach Anwendungsfall zwischen den folgenden Optionen:

      1. Für SharePoint Online-Authentifizierung: Wählen Sie zwischen Standardauthentifizierung und OAuth 2.0-Authentifizierung.

      2. Für SharePoint Server: Wählen Sie zwischen Keine, LDAP und Manuell.

    4. Für AWS Secrets Manager geheim — Wählen Sie ein vorhandenes Geheimnis aus, oder erstellen Sie ein neues Secrets Manager Geheimnis, um Ihre Authentifizierungsdaten zu speichern. SharePoint Wenn Sie ein neues Geheimnis erstellen möchten, wird ein AWS Secrets Manager geheimes Fenster geöffnet. Sie müssen einen geheimen Namen eingeben. Das Präfix 'AmazonKendra-SharePoint-' wird automatisch zu Ihrem geheimen Namen hinzugefügt.

    5. Geben Sie im Fenster Create an AWS Secrets Manager secret die folgenden weiteren Informationen ein:

      1. Wählen Sie je nach Anwendungsfall eine der folgenden SharePoint Cloud-Authentifizierungsoptionen aus:

        1. Standardauthentifizierung — Geben Sie den Benutzernamen Ihres SharePoint Kontos als Benutzername und das SharePoint Kontokennwort als Passwort ein.

        2. OAuth 2.0-Authentifizierung — Geben Sie Ihren SharePoint Kontobenutzernamen als Benutzername, das SharePoint Kontokennwort als Passwort , Ihre automatisch generierte eindeutige SharePoint ID als Client-ID und die gemeinsame geheime Zeichenfolge, die von beiden SharePoint verwendet wird, sowie als Client-Schlüssel ein. Amazon Kendra

      2. Wählen Sie je nach Anwendungsfall eine der folgenden Optionen für die SharePoint Serverauthentifizierung aus:

        1. Keine — Geben Sie Ihren SharePoint Kontobenutzernamen als Benutzernamen, Ihr SharePoint Kontokennwort als Passwort und Ihren Serverdomänennamen ein.

        2. LDAP — Geben Sie Ihren SharePoint Kontobenutzernamen als Benutzernamen, das SharePoint Kontokennwort als Passwort, Ihren LDAP-Serverendpunkt (einschließlich Protokoll und Portnummer, z. B.ldap://example.com:389) und Ihre LDAP-Suchbasis (z. B.) ein. dc=example, dc=com

        3. Manuell — Geben Sie Ihren SharePoint Kontobenutzernamen als Benutzernamen, Ihr SharePoint Kontokennwort als Passwort und Ihre E-Mail-Domain Override (E-Mail-Domain des Verzeichnisbenutzers oder der Verzeichnisgruppe) ein.

      3. Wählen Sie Speichern.

    6. Virtual Private Cloud (VPC) — Sie müssen auch Subnetze und VPC-Sicherheitsgruppen hinzufügen.

      Anmerkung

      Sie müssen eine VPC verwenden, wenn Sie Server verwenden. SharePoint Amazon VPC ist für andere SharePoint Versionen optional.

    7. IAM role — Wählen Sie eine vorhandene IAM Rolle aus oder erstellen Sie eine neue IAM Rolle, um auf Ihre Repository-Anmeldeinformationen und Indexinhalte zuzugreifen.

      Anmerkung

      IAM Rollen, die für Indizes verwendet werden, können nicht für Datenquellen verwendet werden. Wenn Sie sich nicht sicher sind, ob eine vorhandene Rolle für einen Index oder häufig gestellte Fragen verwendet wird, wählen Sie Neue Rolle erstellen, um Fehler zu vermeiden.

    8. Wählen Sie Weiter aus.

  7. Geben Sie auf der Seite Synchronisierungseinstellungen konfigurieren die folgenden Informationen ein:

    1. Änderungsprotokoll verwenden — Wählen Sie diese Option, um Ihren Index zu aktualisieren, anstatt alle Ihre Dateien zu synchronisieren.

    2. Anlagen crawlen — Wählen Sie diese Option, um Anlagen zu crawlen.

    3. Lokale Gruppenzuordnungen verwenden — Wählen Sie diese Option, um sicherzustellen, dass Dokumente ordnungsgemäß gefiltert werden.

    4. Zusätzliche Konfiguration — Fügen Sie Muster für reguläre Ausdrücke hinzu, um bestimmte Dateien ein- oder auszuschließen. Sie können bis zu 100 Muster hinzufügen.

    5. In Sync ausgeführter Zeitplan für die Häufigkeit — Gibt an, wie oft mit Ihrer Datenquelle synchronisiert Amazon Kendra wird.

    6. Wählen Sie Weiter aus.

  8. Geben Sie auf der Seite Feldzuordnungen festlegen die folgenden Informationen ein:

    1. Amazon Kendra Standardfeldzuordnungen — Wählen Sie aus den Amazon Kendra generierten Standarddatenquellenfeldern aus, die Sie Ihrem Index zuordnen möchten.

    2. Für benutzerdefinierte Feldzuordnungen — Fügen Sie benutzerdefinierte Datenquellenfelder hinzu, um einen Indexfeldnamen für die Zuordnung und den Felddatentyp zu erstellen.

    3. Wählen Sie Weiter aus.

  9. Überprüfen Sie auf der Seite Überprüfen und erstellen, ob die eingegebenen Informationen korrekt sind, und wählen Sie dann Datenquelle hinzufügen aus. Sie können Ihre Informationen auch auf dieser Seite bearbeiten. Ihre Datenquelle wird auf der Seite Datenquellen angezeigt, nachdem die Datenquelle erfolgreich hinzugefügt wurde.

API

Um eine Verbindung Amazon Kendra herzustellen SharePoint

Mithilfe der SharePointConfiguration API müssen Sie Folgendes angeben:

  • SharePointVersion — Geben Sie die SharePoint Version an, die Sie bei der Konfiguration SharePoint verwenden. Dies ist unabhängig davon der Fall, ob Sie SharePoint Server 2013, SharePoint Server Subscription Edition oder SharePoint Online verwenden.

  • Geheimer Amazon-Ressourcenname (ARN) — Geben Sie den Amazon-Ressourcennamen (ARN) eines Secrets Manager Geheimnisses an, das die Authentifizierungsdaten enthält, die Sie in Ihrem SharePoint Konto erstellt haben. Das Geheimnis wird in einer JSON-Struktur gespeichert.

    Für die SharePoint Online-Standardauthentifizierung ist Folgendes die JSON-Mindeststruktur, die in Ihrem Secret enthalten sein muss:

    {
    "userName": "user name",
    "password": "password"
}

    Für die SharePoint Online-OAuth 2.0-Authentifizierung ist Folgendes die JSON-Mindeststruktur, die in Ihrem Geheimnis enthalten sein muss:

    {
    "userName": "SharePoint account user name"",
    "password": "SharePoint account password",
    "clientId": "SharePoint auto-generated unique client id",
    "clientSecret": "secret string shared by Amazon Kendra and SharePoint to authorize communications"
}

    Für die SharePoint Server-Basisauthentifizierung ist Folgendes die JSON-Mindeststruktur, die geheim sein muss:

    {
    "userName": "user name",
    "password": "password",
    "domain": "server domain name"
}

    Für die SharePoint Server-LDAP-Authentifizierung (wenn Sie Ihre Zugriffskontrollliste (ACL) in das E-Mail-Format konvertieren müssen, um den Benutzerkontext zu filtern, können Sie die LDAP-Server-URL und die LDAP-Suchbasis in Ihr Geheimnis aufnehmen), ist Folgendes die JSON-Mindeststruktur, die in Ihrem Geheimnis enthalten sein muss:

    {
    "userName": "user name",
    "password": "password",
    "domain": "server domain name"
    "ldapServerUrl": "ldap://example.com:389",
    "ldapSearchBase": "dc=example,dc=com"
}

    Für die manuelle SharePoint Serverauthentifizierung muss die folgende JSON-Struktur mindestens geheim sein:

    {
    "userName": "user name",
    "password": "password",
    "domain": "server domain name",
    "emailDomainOverride": "example.com"
}

  • IAM role — Geben Sie anRoleArn, wann Sie aufrufenCreateDataSource, um einer IAM Rolle Berechtigungen für den Zugriff auf Ihr Secrets Manager geheimes Passwort und zum Aufrufen der erforderlichen öffentlichen APIs für den SharePoint Connector und Amazon Kendra zu gewähren. Weitere Informationen finden Sie unter IAM Rollen für SharePoint Datenquellen.

  • Amazon VPC— Wenn Sie SharePoint Server verwenden, geben Sie dies VpcConfiguration als Teil der Datenquellenkonfiguration an. Siehe Konfiguration für Amazon Kendra die Verwendung einer VPC.

Sie können auch die folgenden optionalen Funktionen hinzufügen:

  • Webproxy — Ob Sie über einen Webproxy eine Verbindung zu den URLs Ihrer SharePoint Website herstellen möchten. Sie können diese Option nur für SharePoint Server verwenden.

  • Indizierung von Listen — Gibt an, ob Amazon Kendra der Inhalt von Anlagen zu SharePoint Listenelementen indexiert werden soll.

  • Änderungsprotokoll — Gibt an, ob anhand des Change-Log-Mechanismus für die SharePoint Datenquelle ermittelt werden Amazon Kendra soll, ob ein Dokument im Index aktualisiert werden muss.

    Anmerkung

    Verwenden Sie das Änderungsprotokoll, wenn Sie nicht alle Dokumente scannen Amazon Kendra möchten. Wenn Ihr Änderungsprotokoll umfangreich ist, dauert das Scannen der Dokumente in der SharePoint Datenquelle möglicherweise Amazon Kendra weniger Zeit als das Verarbeiten des Änderungsprotokolls. Wenn Sie Ihre SharePoint-Datenquelle zum ersten Mal mit Ihrem Index synchronisieren, werden alle Dokumente durchsucht.

  • Aufnahme- und Ausschlussfilter — Sie können angeben, ob bestimmte Inhalte ein- oder ausgeschlossen werden sollen.

    Anmerkung

    Die meisten Datenquellen verwenden Muster mit regulären Ausdrücken, bei denen es sich um Ein- oder Ausschlussmuster handelt, die als Filter bezeichnet werden. Wenn Sie einen Einschlussfilter angeben, werden nur Inhalte indexiert, die dem Einschlussfilter entsprechen. Jedes Dokument, das dem Einschlussfilter nicht entspricht, wird nicht indexiert. Wenn Sie einen Aufnahme- und Ausschlussfilter angeben, werden Dokumente, die dem Ausschlussfilter entsprechen, nicht indexiert, auch wenn sie dem Einschlussfilter entsprechen.

  • Feldzuordnungen — Wählen Sie diese Option, um Ihre SharePoint Datenquellenfelder Ihren Indexfeldern zuzuordnen. Amazon Kendra Weitere Informationen finden Sie unter Zuweisen von Datenquellenfeldern.

    Anmerkung

    Das Textfeld des Dokuments oder das entsprechende Textfeld für Ihre Dokumente ist erforderlich, um Ihre Dokumente durchsuchen Amazon Kendra zu können. Sie müssen den Feldnamen für den Dokumenttext in Ihrer Datenquelle dem Indexfeldnamen zuordnen_document_body. Alle anderen Felder sind optional.

  • Benutzerkontextfilterung und Zugriffskontrolle Amazon Kendra — durchsucht die Zugriffskontrollliste (ACL) für Ihre Dokumente, sofern Sie eine ACL für Ihre Dokumente haben. Die ACL-Informationen werden verwendet, um Suchergebnisse basierend auf dem Benutzer- oder Gruppenzugriff auf Dokumente zu filtern. Weitere Informationen finden Sie unter Benutzerkontextfilterung.

Weitere Informationen

Weitere Informationen zur Integration Amazon Kendra mit Ihrer SharePoint Datenquelle finden Sie unter: