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.

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

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

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

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

Indexfelder für eine Datei erstellen FAQ

Wenn Sie eine benutzerdefinierte Eingabe CSV oder eine JSONDatei 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 das in einer Antwort zurückgegeben FAQ wird, 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 den verwendenAPI, müssen Sie zuerst ein Indexfeld mit dem UpdateIndexAPIerstellen.

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. Sie müssen also 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 von überprüfen. DescribeIndexAPI

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 JSON Datei CSV oder Datei verwenden. Weitere Informationen finden Sie unter Dokumentattribute oder -felder.

CSVBasisdatei

Verwenden Sie eine CSV Basisdatei, wenn Sie eine einfache Struktur für Ihre verwenden möchtenFAQs. In einer CSV Basisdatei hat jede Zeile zwei oder drei Felder: eine Frage, eine Antwort und eine optionale Quelle, URI die auf ein Dokument mit weiteren Informationen verweist.

Der Inhalt der Datei muss dem allgemeinen Format und MIME Typ RFC 4180 für Dateien mit kommagetrennten Werten () CSV entsprechen.

Bei der folgenden Datei handelt es sich um eine FAQ Datei im Basisformat. CSV

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. Bei einer benutzerdefinierten 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 Datei kann sowohl Amazon Kendra reservierte Felder als auch 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 allgemeinen Format und MIME Typ RFC 4180 für Dateien mit kommagetrennten Werten () CSV entsprechen.

Im Folgenden sind 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 bestimmte Benutzer und Gruppen FAQ 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ührtFAQs:

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

JSONDatei

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 zum hinzufügenFAQ.

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 bestimmte Benutzer und Gruppen FAQ 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 Integration der Benutzerzugriffskontrolle für eine JSONFAQ.

"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 CreateFaqAPI, um die Fragen und Antworten in Ihren Index aufzunehmen. Wenn Sie eine aktualisieren möchtenFAQ, löschen Sie die FAQ und erstellen Sie sie erneut. Sie verwenden die DeleteFaqAPI, um eine zu löschenFAQ.

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.

Python

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)

Java

package com.amazonaws.kendra;

import software.amazon.awssdk.services.kendra.KendraClient;
import software.amazon.awssdk.services.kendra.model.CreateFaqRequest;
import software.amazon.awssdk.services.kendra.model.CreateFaqResponse;
import software.amazon.awssdk.services.kendra.model.S3Path;

public class AddFaqExample {
    public static void main(String[] args) {
        KendraClient kendra = KendraClient.builder().build();

        String indexId = "yourIndexId";
        String roleArn = "your role for accessing S3 files";

        CreateFaqRequest createFaqRequest = CreateFaqRequest
            .builder()
            .indexId(indexId)
            .name("FreeClinicsUSA")
            .roleArn(roleArn)
            .s3Path(
                S3Path
                    .builder()
                    .bucket("amzn-s3-demo-bucket")
                    .key("FreeClinicsUSA.csv")
                    .build())
            .build();

        CreateFaqResponse response = kendra.createFaq(createFaqRequest);

        System.out.println(String.format("The result of creating FAQ: %s", response));

    }
}

FAQDateien in anderen Sprachen als Englisch

Sie können eine FAQ in einer unterstützten Sprache indizieren. Amazon Kendra Indizes standardmäßig FAQs 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 a als Feld FAQ in die FAQ Metadaten aufnehmen. Wenn die Metadaten von a FAQ keinen Sprachcode enthalten, der in einem Metadatenfeld angegeben FAQ ist, wird der anhand des Sprachcodes indexiert, der beim Aufrufen der CreateFAQ Operation angegeben wurde. Um ein FAQ Dokument in einer unterstützten Sprache in der Konsole zu indizieren, wechseln Sie zu FAQsund wählen Sie Hinzufügen FAQ aus. Sie wählen eine Sprache aus dem Drop-down-Menü Sprache aus.