Häufig gestellte Fragen (FAQs) zu einem Index hinzufügen

Über die Konsole oder die CreateFaqAPI können Sie häufig gestellte Fragen (FAQs) direkt zu Ihrem Index hinzufügen. Das Hinzufügen FAQs zu einem Index ist ein asynchroner Vorgang. Sie fügen die Daten für die häufig gestellten Fragen in eine Datei ein, die Sie in einem Amazon Simple Storage Service Bucket speichern. Sie können CSV- oder JSON-Dateien als Eingabe für Ihre FAQ verwenden:

Im Folgenden finden Sie beispielsweise eine einfache CSV-Datei, die Antworten auf Fragen zu kostenlosen Kliniken in Spokane, Washington, USA, und Mountain View, Missouri, USA, enthält.

How many free clinics are in Spokane WA?, 13
How many free clinics are there in Mountain View Missouri?, 7

Indexfelder für eine FAQ-Datei erstellen

Wenn Sie eine benutzerdefinierte CSV - oder JSON-Datei für die Eingabe verwenden, können Sie benutzerdefinierte Felder für Ihre FAQ-Fragen deklarieren. Sie können beispielsweise ein benutzerdefiniertes Feld erstellen, das jeder FAQ-Frage eine Geschäftsabteilung zuweist. Wenn die häufig gestellten Fragen in einer Antwort zurückgegeben werden, können Sie die Abteilung als Facette verwenden, um die Suche beispielsweise nur auf „Personal“ oder „Finanzen“ zu beschränken.

Ein benutzerdefiniertes Feld muss einem Indexfeld zugeordnet sein. In der Konsole verwenden Sie die Facet-Definitionsseite, um ein Indexfeld zu erstellen. Wenn Sie die API verwenden, müssen Sie zunächst mithilfe der UpdateIndexAPI ein Indexfeld erstellen.

Der Feld-/Attributtyp in der FAQ-Datei muss mit dem Typ des zugehörigen Indexfeldes übereinstimmen. Das Feld „Abteilung“ ist beispielsweise ein STRING_LIST Typfeld. Daher müssen Sie Werte für das Abteilungsfeld als Zeichenfolgenliste in Ihrer FAQ-Datei angeben. Sie können den Typ der Indexfelder auf der Facet-Definitionsseite in der Konsole oder mithilfe der DescribeIndexAPI überprüfen.

Wenn Sie ein Indexfeld erstellen, das einem benutzerdefinierten Attribut zugeordnet ist, können Sie es als anzeigbar, facetierbar oder sortierbar kennzeichnen. Sie können ein benutzerdefiniertes Attribut nicht durchsuchbar machen.

Zusätzlich zu den benutzerdefinierten Attributen können Sie auch die Amazon Kendra reservierten oder allgemeinen Felder in einer benutzerdefinierten CSV- oder JSON-Datei verwenden. Weitere Informationen finden Sie unter Dokumentattribute oder -felder.

Einfache CSV-Datei

Verwenden Sie eine einfache CSV-Datei, wenn Sie eine einfache Struktur für Ihre verwenden möchten FAQs. In einer einfachen CSV-Datei hat jede Zeile zwei oder drei Felder: eine Frage, eine Antwort und einen optionalen Quell-URI, der auf ein Dokument mit weiteren Informationen verweist.

Der Inhalt der Datei muss dem RFC 4180 Common Format and MIME Type for Comma-Separated Values (CSV) -Dateien entsprechen.

Im Folgenden finden Sie eine FAQ-Datei im grundlegenden CSV-Format.

How many free clinics are in Spokane WA?, 13, https://s3.region.company.com/bucket-name/directory/faq.csv
How many free clinics are there in Mountain View Missouri?, 7, https://s3.region.company.com/bucket-name/directory/faq.csv

Benutzerdefinierte CSV-Datei

Verwenden Sie eine benutzerdefinierte CSV-Datei, wenn Sie Ihren FAQ-Fragen benutzerdefinierte Felder/Attribute hinzufügen möchten. Für eine benutzerdefinierte CSV-Datei verwenden Sie eine Kopfzeile in Ihrer CSV-Datei, um die zusätzlichen Attribute zu definieren.

Die CSV-Datei muss die folgenden zwei Pflichtfelder enthalten:

Ihre benutzerdefinierte CSV-Datei kann sowohl Amazon Kendra reservierte Felder (außer_faq_id, _data_source_id_document_title, und_file_type) als auch beliebige benutzerdefinierte Felder enthalten.

Im Folgenden finden Sie ein Beispiel für eine benutzerdefinierte CSV-Datei.

_question,_answer,_last_updated_at,custom_string
How many free clinics are in Spokane WA?, 13, 2012-03-25T12:30:10+01:00, Note: Some free clinics require you to meet certain criteria in order to use their services
How many free clinics are there in Mountain View Missouri?, 7, 2012-03-25T12:30:10+01:00, Note: Some free clinics require you to meet certain criteria in order to use their services

Der Inhalt der benutzerdefinierten Datei muss dem RFC 4180 Common Format and MIME Type for Comma-Separated Values (CSV) -Dateien entsprechen.

Im Folgenden werden die Typen von benutzerdefinierten Feldern aufgeführt:

Eine benutzerdefinierte CSV-Datei kann Felder für die Benutzerzugriffskontrolle enthalten. Sie können diese Felder verwenden, um den Zugriff auf die häufig gestellten Fragen auf bestimmte Benutzer und Gruppen zu beschränken. Um nach Benutzerkontext zu filtern, muss der Benutzer Benutzer- und Gruppeninformationen in der Abfrage angeben. Andernfalls FAQs werden alle relevanten Daten zurückgegeben. Weitere Informationen finden Sie unter Benutzerkontextfilterung.

Im Folgenden sind die Benutzerkontextfilter für aufgeführt FAQs:

Geben Sie die Werte für die Listen „Zulassen“ und „Verweigern“ in kommagetrennten Listen in Anführungszeichen ein (z. B."user1,user2,user3"). Sie können einen Benutzer oder eine Gruppe entweder in eine Zulassungsliste oder in eine Ablehnungsliste aufnehmen, aber nicht beide, wenn derselbe Benutzer einzeln zugelassen ist, sondern auch, wenn die Gruppe verweigert wurde. Wenn Sie einen Benutzer oder eine Gruppe in beide aufnehmen, erhalten Sie eine Fehlermeldung.

Im Folgenden finden Sie ein Beispiel für eine benutzerdefinierte CSV-Datei mit Benutzerkontextinformationen.

_question, _answer, _acl_user_allow, _acl_user_deny, _acl_group_allow, _acl_group_deny
How many free clinics are in Spokane WA?, 13, "userID6201,userID7552", "userID1001,userID2020", groupBasicPlusRate, groupPremiumRate

JSON-Datei

Sie können eine JSON-Datei verwenden, um Fragen, Antworten und Felder für Ihren Index bereitzustellen. Sie können jedes der Amazon Kendra reservierten Felder oder benutzerdefinierten Felder zu den häufig gestellten Fragen hinzufügen.

Das Folgende ist das Schema für die JSON-Datei.

{
    "SchemaVersion": 1,
    "FaqDocuments": [
        {
            "Question": string,
            "Answer": string,
            "Attributes": {
                string: object
                additional attributes
            },
            "AccessControlList": [
               {
                   "Name": string,
                   "Type": enum( "GROUP" | "USER" ),
                   "Access": enum( "ALLOW" | "DENY" )
               },
               additional user context
            ]
        },
        additional FAQ documents
    ]
}

Die folgende JSON-Beispieldatei zeigt zwei FAQ-Dokumente. Eines der Dokumente enthält nur die erforderliche Frage und Antwort. Das andere Dokument enthält auch zusätzliche Feld- und Benutzerkontext- oder Zugriffskontrollinformationen.

{
    "SchemaVersion": 1,
    "FaqDocuments": [
        {
            "Question": "How many free clinics are in Spokane WA?",
            "Answer": "13"
        },
        {
            "Question": "How many free clinics are there in Mountain View Missouri?",
            "Answer": "7",
            "Attributes": {
                "_source_uri": "https://s3.region.company.com/bucket-name/directory/faq.csv",
                "_category": "Charitable Clinics"
            },
            "AccessControlList": [
               {
                   "Name": "user@amazon.com",
                   "Type": "USER",
                   "Access": "ALLOW"
               },
               {
                   "Name": "Admin",
                   "Type": "GROUP",
                   "Access": "ALLOW"
               }
            ]
        }
    ]
}

Im Folgenden werden die Typen von benutzerdefinierten Feldern aufgeführt:

Eine JSON-Datei kann Felder für die Benutzerzugriffskontrolle enthalten. Sie können diese Felder verwenden, um den Zugriff auf die häufig gestellten Fragen auf bestimmte Benutzer und Gruppen zu beschränken. Um nach Benutzerkontext zu filtern, muss der Benutzer Benutzer- und Gruppeninformationen in der Abfrage angeben. Andernfalls FAQs werden alle relevanten Daten zurückgegeben. Weitere Informationen finden Sie unter Benutzerkontextfilterung.

Sie können einen Benutzer oder eine Gruppe entweder in eine Zulassungsliste oder eine Ablehnungsliste aufnehmen, aber nicht in beiden Fällen, in denen derselbe Benutzer einzeln zugelassen wird, sondern auch, wenn die Gruppe verweigert wird. Wenn Sie einen Benutzer oder eine Gruppe in beide aufnehmen, erhalten Sie eine Fehlermeldung.

Im Folgenden finden Sie ein Beispiel für die Einbindung der Benutzerzugriffskontrolle in häufig gestellte Fragen zu JSON.

"AccessControlList": [
                {
                    "Name": "group or user name",
                    "Type": "GROUP | USER",
                    "Access": "ALLOW | DENY"
                },
                additional user context
            ]
   

Verwenden Sie Ihre FAQ-Datei

Nachdem Sie Ihre FAQ-Eingabedatei in einem S3-Bucket gespeichert haben, verwenden Sie die Konsole oder die CreateFaq API, um die Fragen und Antworten in Ihren Index aufzunehmen. Wenn Sie eine häufig gestellte Frage aktualisieren möchten, löschen Sie die häufig gestellten Fragen und erstellen Sie sie erneut. Sie verwenden die DeleteFaq API, um eine FAQ zu löschen.

Sie müssen eine IAM Rolle angeben, die Zugriff auf den S3-Bucket hat, der Ihre Quelldateien enthält. Sie geben die Rolle in der Konsole oder im RoleArn Parameter an. Im Folgenden finden Sie ein Beispiel für das Hinzufügen einer FAQ-Datei zu einem Index.

import boto3

kendra = boto3.client("kendra")

# Provide the index ID
index_id = "index-id"
# Provide the IAM role ARN required to index documents in an S3 bucket
role_arn = "arn:aws:iam::${accountId}:role/${roleName}"

# Provide the S3 bucket path information to the FAQ file
faq_path = {
    "Bucket": "bucket-name",
    "Key": "FreeClinicsUSA.csv"
}

response = kendra.create_faq(
    S3Path =  faq_path,
    Name = "FreeClinicsUSA",
    IndexId = index_id,
    RoleArn = role_arn
)

print(response)

FAQ-Dateien in anderen Sprachen als Englisch

Sie können häufig gestellte Fragen in einer unterstützten Sprache indexieren. Amazon Kendra FAQs indexiert standardmäßig auf Englisch, wenn Sie keine Sprache angeben. Sie geben den Sprachcode an, wenn Sie den CreateFaqVorgang aufrufen, oder Sie können den Sprachcode für eine häufig gestellte Frage als Feld in die FAQ-Metadaten aufnehmen. Wenn die Metadaten einer häufig gestellten Frage keinen Sprachcode enthalten, der in einem Metadatenfeld angegeben ist, wird die häufig gestellte Frage anhand des Sprachcodes indexiert, der beim Aufrufen des CreateFAQ Vorgangs angegeben wurde. Um ein FAQ-Dokument in einer unterstützten Sprache in der Konsole zu indexieren, wechseln Sie zu FAQsund wählen Sie FAQ hinzufügen aus. Sie wählen eine Sprache aus dem Drop-down-Menü Sprache aus.