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.
# Einen Index durchsuchen
**Anmerkung**
Die Funktionsunterstützung variiert je nach Indextyp und verwendeter Such-API. Informationen darüber, ob diese Funktion für den von Ihnen verwendeten Indextyp und die Such-API unterstützt wird, finden Sie unter [Indextypen](https://docs.aws.amazon.com/kendra/latest/dg/hiw-index-types.html).
Um einen Amazon Kendra Index zu durchsuchen, verwenden Sie die [Abfrage-API](https://docs.aws.amazon.com/kendra/latest/APIReference/API_Query.html). Die `Query` API gibt Informationen zu den indizierten Dokumenten zurück, die Sie in Ihrer Anwendung verwenden. In diesem Abschnitt erfahren Sie, wie Sie eine Abfrage stellen, Filter durchführen und die Antwort interpretieren, die Sie von der `Query` API erhalten.
Verwenden Sie [AMAZON, um nach Dokumenten zu suchen Amazon Lex, die Sie mit Amazon Kendra for indexiert haben. KendraSearchIntent](https://docs.aws.amazon.com/lexv2/latest/APIReference/API_KendraConfiguration.html). Ein Beispiel für die Konfiguration Amazon Kendra mit Amazon Lex finden Sie unter [Einen FAQ-Bot für einen Amazon Kendra Index](https://docs.aws.amazon.com/lexv2/latest/dg/faq-bot-kendra-search.html) erstellen.
**Topics**
+ [
# Abfragen eines Index
](searching-example.md)
+ [
# Passagen werden abgerufen
](searching-retrieve.md)
+ [
# Einen Index durchsuchen
](browsing.md)
+ [
# Mit Suchergebnissen
](featured-results.md)
+ [
# Tabellarische Suche nach HTML
](searching-tables.md)
+ [
# Vorschläge für Abfragen
](query-suggestions.md)
+ [
# Rechtschreibprüfung abfragen
](query-spell-check.md)
+ [
# Filterung und Facettensuche
](filtering.md)
+ [
# Filtern nach Benutzerkontext
](user-context-filter.md)
+ [
# Antworten und Antworttypen abfragen
](query-responses-types.md)
+ [
# Antworten optimieren und sortieren
](tuning-sorting-responses.md)
+ [
# Abfrageergebnisse reduzieren/erweitern
](expand-collapse-query-results.md)
# Abfragen eines Index
**Anmerkung**
Die Funktionsunterstützung variiert je nach Indextyp und verwendeter Such-API. Informationen darüber, ob diese Funktion für den von Ihnen verwendeten Indextyp und die Such-API unterstützt wird, finden Sie unter [Indextypen](https://docs.aws.amazon.com/kendra/latest/dg/hiw-index-types.html).
Wenn Sie Ihren Index durchsuchen, Amazon Kendra verwendet es alle Informationen, die Sie zu Ihren Dokumenten angegeben haben, um die Dokumente zu ermitteln, die für die eingegebenen Suchbegriffe am relevantesten sind. Dabei werden unter anderem folgende Punkte Amazon Kendra berücksichtigt:
+ Der Text oder der Hauptteil des Dokuments.
+ Der Titel des Dokuments.
+ Benutzerdefinierte Textfelder, die Sie als durchsuchbar markiert haben.
+ Das von Ihnen angegebene Datumsfeld sollte verwendet werden, um die „Aktualität“ eines Dokuments zu bestimmen.
+ Jedes andere Feld, das relevante Informationen liefern könnte.
Amazon Kendra kann die Antwort auch anhand von field/attribute Filtern filtern, die Sie möglicherweise für die Suche festgelegt haben. Wenn Sie beispielsweise über ein benutzerdefiniertes Feld mit dem Namen „Abteilung“ verfügen, können Sie die Antwort so filtern, dass nur Dokumente aus einer Abteilung mit dem Namen „Rechtsabteilung“ zurückgegeben werden. Weitere Informationen finden Sie unter [Benutzerdefinierte Felder oder Attribute](https://docs.aws.amazon.com/kendra/latest/dg/custom-attributes.html).
Die zurückgegebenen Suchergebnisse sind nach der Relevanz sortiert, die für jedes Dokument Amazon Kendra maßgeblich ist. Die Ergebnisse sind paginiert, sodass Sie Ihrem Benutzer jeweils eine Seite anzeigen können.
[Verwenden Sie AMAZON, um nach Dokumenten zu suchen, die Sie mit Amazon Kendra for Amazon Lex indexiert haben. KendraSearchIntent](https://docs.aws.amazon.com/lexv2/latest/APIReference/API_KendraConfiguration.html). Ein Beispiel für die Konfiguration Amazon Kendra mit Amazon Lex finden Sie unter [Einen FAQ-Bot für einen Amazon Kendra Index](https://docs.aws.amazon.com/lexv2/latest/dg/faq-bot-kendra-search.html) erstellen.
Das folgende Beispiel zeigt, wie ein Index durchsucht wird. Amazon Kendra bestimmt den Typ des Suchergebnisses (Antwort, Dokument, Frage-Antwort), der für die Abfrage am besten geeignet ist. Sie können nicht so konfigurieren Amazon Kendra , dass eine bestimmte Art von Suchantwort (Antwort, Dokument, Frage-Antwort) auf eine Abfrage zurückgegeben wird.
Informationen zu den Abfrageantworten finden Sie unter. [Antworten und Antworttypen abfragen](query-responses-types.md)
**Topics**
+ [
## Voraussetzungen
](#searching-prerequisites)
+ [
## Einen Index durchsuchen (Konsole)
](#searching-index-console)
+ [
## Einen Index durchsuchen (SDK)
](#searching-index-sdk)
+ [
## Einen Index durchsuchen (Postman)
](#searching-index-postman)
+ [
## Suche mit erweiterter Abfragesyntax
](#searching-index-query-syntax)
+ [
## In Sprachen suchen
](#searching-index-languages)
## Voraussetzungen
Bevor Sie mit der [Query](https://docs.aws.amazon.com/kendra/latest/APIReference/API_Query.html) API einen Index abfragen:
+ Richten Sie die erforderlichen Berechtigungen für einen Index ein und stellen Sie eine Verbindung zu Ihrer Datenquelle her oder laden Sie Ihre Dokumente stapelweise hoch. Weitere Informationen finden Sie unter [IAM Rollen](https://docs.aws.amazon.com/kendra/latest/dg/iam-roles.html). Sie verwenden den Amazon-Ressourcennamen der Rolle, wenn Sie die API aufrufen, um einen Index- und Datenquellen-Connector oder einen Batch-Upload von Dokumenten zu erstellen.
+ Richten Sie entweder AWS Command Line Interface das SDK ein oder rufen Sie die Amazon Kendra Konsole auf. Weitere Informationen finden Sie unter [Einrichten Amazon Kendra](https://docs.aws.amazon.com/kendra/latest/dg/setup.html).
+ Erstellen Sie einen Index und stellen Sie eine Verbindung zu einer Datenquelle mit Dokumenten her oder laden Sie Dokumente stapelweise hoch. Weitere Informationen finden Sie unter [Erstellen eines Indexes](https://docs.aws.amazon.com/kendra/latest/dg/create-index.html) und [Erstellen eines Datenquellenconnectors](https://docs.aws.amazon.com/kendra/latest/dg/data-source.html).
## Einen Index durchsuchen (Konsole)
Sie können die Amazon Kendra Konsole verwenden, um Ihren Index zu suchen und zu testen. Sie können Abfragen stellen und die Ergebnisse sehen.
**Um einen Index mit der Konsole zu durchsuchen**
1. Melden Sie sich bei der an AWS-Managementkonsole und öffnen Sie die Amazon Kendra Konsole unter [http://console.aws.amazon.com/kendra/](https://console.aws.amazon.com/kendra).
1. Wählen Sie im Navigationsbereich **Indizes** aus.
1. Wählen Sie Ihren Index aus.
1. Wählen Sie im Navigationsmenü die Option, um Ihren Index zu durchsuchen.
1. Geben Sie eine Abfrage in das Textfeld ein und drücken Sie dann die Eingabetaste.
1. Amazon Kendra gibt die Ergebnisse der Suche zurück.
Sie können die Abfrage-ID für die Suche auch abrufen, indem Sie auf das Glühbirnensymbol in der Seitenleiste klicken.
## Einen Index durchsuchen (SDK)
**Um einen Index mit Python oder Java zu durchsuchen**
+ Im folgenden Beispiel wird ein Index durchsucht. Ändern Sie den Wert von `query` in Ihre Suchabfrage `index_id` und/oder in `indexId` den Indexbezeichner des Indexes, den Sie durchsuchen möchten.
Sie können die Abfrage-ID für die Suche auch als Teil der Antwortelemente abrufen, wenn Sie die [Abfrage-API](https://docs.aws.amazon.com/kendra/latest/APIReference/API_Query.html) aufrufen.
------
#### [ Python ]
```
import boto3
import pprint
kendra = boto3.client("kendra")
# Provide the index ID
index_id = "index-id"
# Provide the query text
query = "query text"
response = kendra.query(
QueryText = query,
IndexId = index_id)
print("\nSearch results for query: " + query + "\n")
for query_result in response["ResultItems"]:
print("-------------------")
print("Type: " + str(query_result["Type"]))
if query_result["Type"]=="ANSWER" or query_result["Type"]=="QUESTION_ANSWER":
answer_text = query_result["DocumentExcerpt"]["Text"]
print(answer_text)
if query_result["Type"]=="DOCUMENT":
if "DocumentTitle" in query_result:
document_title = query_result["DocumentTitle"]["Text"]
print("Title: " + document_title)
document_text = query_result["DocumentExcerpt"]["Text"]
print(document_text)
print("------------------\n\n")
```
------
#### [ Java ]
```
package com.amazonaws.kendra;
import software.amazon.awssdk.services.kendra.KendraClient;
import software.amazon.awssdk.services.kendra.model.QueryRequest;
import software.amazon.awssdk.services.kendra.model.QueryResponse;
import software.amazon.awssdk.services.kendra.model.QueryResultItem;
public class SearchIndexExample {
public static void main(String[] args) {
KendraClient kendra = KendraClient.builder().build();
String query = "query text";
String indexId = "index-id";
QueryRequest queryRequest = QueryRequest
.builder()
.queryText(query)
.indexId(indexId)
.build();
QueryResponse queryResponse = kendra.query(queryRequest);
System.out.println(String.format("\nSearch results for query: %s", query));
for(QueryResultItem item: queryResponse.resultItems()) {
System.out.println("----------------------");
System.out.println(String.format("Type: %s", item.type()));
switch(item.type()) {
case QUESTION_ANSWER:
case ANSWER:
String answerText = item.documentExcerpt().text();
System.out.println(answerText);
break;
case DOCUMENT:
String documentTitle = item.documentTitle().text();
System.out.println(String.format("Title: %s", documentTitle));
String documentExcerpt = item.documentExcerpt().text();
System.out.println(String.format("Excerpt: %s", documentExcerpt));
break;
default:
System.out.println(String.format("Unknown query result type: %s", item.type()));
}
System.out.println("-----------------------\n");
}
}
}
```
------
## Einen Index durchsuchen (Postman)
Sie können [Postman](https://www.postman.com/) verwenden, um Ihren Amazon Kendra Index abzufragen und zu testen.
**Um einen Index mit Postman zu durchsuchen**
1. **Erstellen Sie eine neue Sammlung in Postman und legen Sie den Anforderungstyp auf POST fest.**
1. Geben Sie die Endpunkt-URL ein. Zum Beispiel *https://kendra. .amazonaws.com*.
1. Wählen Sie die Registerkarte **Autorisierung** und geben Sie die folgenden Informationen ein.
+ **Typ** — Wählen Sie die **AWS Signatur** aus.
+ **AccessKey**— Geben Sie den Zugriffsschlüssel ein, der beim Erstellen eines IAM Benutzers generiert wurde.
+ **SecretKey**— Geben Sie den geheimen Schlüssel ein, der beim Erstellen eines IAM Benutzers generiert wurde.
+ **AWS Region** — Geben Sie die Region Ihres Indexes ein. Zum Beispiel *us-west-2*.
+ **Dienstname — Geben Sie Kendra ein***.* Dabei wird zwischen Groß- und Kleinschreibung unterschieden, also muss es sich um Kleinbuchstaben handeln.
**Warnung**
Wenn Sie den falschen Dienstnamen eingeben oder keine Kleinbuchstaben verwenden, wird ein Fehler ausgegeben, sobald Sie **Senden** auswählen, um die Anfrage zu senden: „Die Anmeldeinformationen sollten auf den richtigen Dienst 'Kendra' beschränkt sein.“
Sie müssen außerdem überprüfen, ob Sie den richtigen Zugriffs- und Geheimschlüssel eingegeben haben.
1. Wählen Sie die Registerkarte **Header** aus und geben Sie die folgenden Schlüssel- und Wertinformationen ein.
+ *Schlüssel: X-Amz-Target*
*Wert: com.amazonaws.kendra. AWSKendraFrontendService*. Abfrage
+ *Schlüssel: Content-Encoding*
*Wert: amz-1.0*
1. Wählen Sie die Registerkarte **Körper** und gehen Sie wie folgt vor.
+ Wählen Sie den **rohen** JSON-Typ für den Hauptteil der Anfrage.
+ Geben Sie eine JSON-Datei ein, die Ihre Index-ID und Ihren Abfragetext enthält.
```
{
"IndexId": "index-id",
"QueryText": "enter a query here"
}
```
**Warnung**
Wenn Ihr JSON nicht die richtige Einrückung verwendet, wird ein Fehler ausgegeben: "“SerializationException. Überprüfe die Einrückung in deinem JSON.
1. Wählen Sie **Senden** (in der Nähe oben rechts) aus.
## Suche mit erweiterter Abfragesyntax
Mithilfe erweiterter Abfragesyntax oder Operatoren können Sie Abfragen erstellen, die spezifischer sind als Abfragen mit einfachen Schlüsselwörtern oder Abfragen in natürlicher Sprache. Dazu gehören Bereiche, Boolesche Werte, Platzhalter und mehr. Durch die Verwendung von Operatoren können Sie Ihrer Abfrage mehr Kontext geben und die Suchergebnisse weiter verfeinern.
Amazon Kendra unterstützt die folgenden Operatoren.
+ Boolean: Logik zur Einschränkung oder Erweiterung der Suche. `amazon AND sports`Beschränkt die Suche beispielsweise darauf, nur nach Dokumenten zu suchen, die beide Begriffe enthalten.
+ Klammern: Liest verschachtelte Abfrageausdrücke in der Reihenfolge ihrer Rangfolge. Liest beispielsweise vorher. `(amazon AND sports) NOT rainforest` `(amazon AND sports)` `NOT rainforest`
+ Bereiche: Datums- oder numerische Bereichswerte. Bereiche können inklusiv, exklusiv oder unbegrenzt sein. Sie können beispielsweise nach Dokumenten suchen, die zuletzt zwischen dem 1. Januar 2020 und dem 31. Dezember 2020 aktualisiert wurden, einschließlich dieser Daten.
+ Felder: Verwendet ein bestimmtes Feld, um die Suche einzuschränken. Sie können beispielsweise nach Dokumenten suchen, die „Vereinigte Staaten“ im Feld „Standort“ enthalten.
+ Platzhalter: Entsprechen teilweise einer Textfolge. `Cloud*`Könnte zum Beispiel übereinstimmen CloudFormation. Amazon Kendra unterstützt derzeit nur Platzhalter am Ende.
+ Exakte Anführungszeichen: Entspricht genau einer Textfolge. Zum Beispiel Dokumente, die enthalten`"Amazon Kendra" "pricing"`.
Sie können eine Kombination aus jedem der oben genannten Operatoren verwenden.
Beachten Sie, dass eine übermäßige Verwendung von Operatoren oder hochkomplexe Abfragen die Abfragelatenz beeinträchtigen können. Platzhalter gehören zu den teuersten Operatoren, was die Latenz angeht. Als allgemeine Regel gilt: Je mehr Begriffe und Operatoren Sie verwenden, desto größer sind die potenziellen Auswirkungen auf die Latenz. Andere Faktoren, die sich auf die Latenz auswirken, sind die durchschnittliche Größe der indexierten Dokumente, die Größe Ihres Indexes, jegliche Filterung von Suchergebnissen und die Gesamtauslastung Ihres Amazon Kendra Index.
### Boolesch
Mithilfe der booleschen Operatoren`AND`,, können Sie Wörter kombinieren oder ausschließen. `OR` `NOT`
Im Folgenden finden Sie Beispiele für die Verwendung boolescher Operatoren.
**`amazon AND sports`**
Gibt Suchergebnisse zurück, die sowohl die Begriffe „Amazon“ als auch „Sport“ im Text enthalten, z. B. Amazon Prime Video Sports oder andere ähnliche Inhalte.
**`sports OR recreation`**
Gibt Suchergebnisse zurück, die die Begriffe „Sport“ oder „Freizeit“ oder beides im Text enthalten.
**`amazon NOT rainforest`**
Gibt Suchergebnisse zurück, die den Begriff „Amazon“, aber nicht den Begriff „Regenwald“ im Text enthalten. Dies dient dazu, nach Dokumenten über das Unternehmen Amazon zu suchen, nicht über den Amazonas-Regenwald.
### Klammern
Sie können verschachtelte Wörter in der Reihenfolge ihrer Rangfolge abfragen, indem Sie Klammern verwenden. Die Klammern geben an, Amazon Kendra wie eine Abfrage gelesen werden soll.
Im Folgenden finden Sie Beispiele für die Verwendung von Klammeroperatoren.
**`(amazon AND sports) NOT rainforest`**
Gibt Dokumente zurück, die sowohl die Begriffe „Amazon“ als auch „Sport“ im Text enthalten, nicht jedoch den Begriff „Regenwald“. Dies dient der Suche nach Amazon Prime-Videosportarten oder ähnlichen Inhalten, nicht nach Abenteuersportarten im Amazonas-Regenwald. Die Klammern weisen darauf hin, dass dies vorher gelesen werden `amazon AND sports` sollte. `NOT rainforest` Die Abfrage sollte nicht als gelesen werden. `amazon AND (sports NOT rainforest)`
**`(amazon AND (sports OR recreation)) NOT rainforest`**
Gibt Dokumente zurück, die die Begriffe „Sport“ oder „Freizeit“ oder beides sowie den Begriff „Amazon“ enthalten. Der Begriff „Regenwald“ ist jedoch nicht enthalten. Dies dient dazu, Amazon Prime Video nach Sport oder Freizeit zu durchsuchen, nicht nach Abenteuersportarten im Amazonas-Regenwald. Die Klammern weisen darauf hin, dass dieser Begriff gelesen werden `sports OR recreation` sollte, bevor er mit dem zuvor gelesenen Wort „Amazon“ kombiniert wird. `NOT rainforest` Die Abfrage sollte nicht als gelesen werden. `amazon AND (sports OR (recreation NOT rainforest))`
### Bereiche
Sie können einen Wertebereich verwenden, um die Suchergebnisse zu filtern. Sie geben ein Attribut und die Bereichswerte an. Dies kann ein Datum oder ein numerischer Typ sein.
Datumsbereiche müssen die folgenden Formate haben:
+ Epoch
+ YYYY
+ YYYY-MM
+ JJJJ-MM-tt
+ Yyyyy-mm-dd't 'hh
Sie können auch angeben, ob die unteren und höheren Werte des Bereichs ein- oder ausgeschlossen werden sollen.
Im Folgenden finden Sie Beispiele für die Verwendung von Bereichsoperatoren.
**`_processed_date:>2019-12-31 AND _processed_date:<2021-01-01`**
Gibt Dokumente zurück, die im Jahr 2020 verarbeitet wurden — also vor dem 31. Dezember 2019 und weniger als dem 1. Januar 2021.
**`_processed_date:>=2020-01-01 AND _processed_date:<=2020-12-31`**
Gibt Dokumente zurück, die im Jahr 2020 bearbeitet wurden — also größer oder gleich dem 1. Januar 2020 und weniger als oder gleich dem 31. Dezember 2020.
**`_document_likes:<1`**
Gibt Dokumente zurück, die keine „Gefällt mir“ -Angaben oder kein Benutzerfeedback haben — weniger als 1 „Gefällt mir“.
Sie können angeben, ob ein Bereich so behandelt werden soll, dass er die angegebenen Bereichswerte einschließt oder ausschließt.
**Inklusiv**
**`_last_updated_at:[2020-01-01 TO 2020-12-31]`**
Gibt Dokumente zurück, die zuletzt im Jahr 2020 aktualisiert wurden — einschließlich der Tage 1. Dezember 2020 und 31. Dezember 2020.
**Exklusiv**
**`_last_updated_at:{2019-12-31 TO 2021-01-01}`**
Gibt Dokumente zurück, die zuletzt im Jahr 2020 aktualisiert wurden — ausgenommen sind die Tage 31. Dezember 2019 und 1. Januar 2021.
< and >Verwenden Sie für unbegrenzte Bereiche, die weder inklusiv noch exklusiv sind, einfach die Operatoren. Beispiel: `_last_updated_at:>2019-12-31 AND _last_updated_at:<2021-01-01`
#### Felder
Sie können Ihre Suche so einschränken, dass nur Dokumente zurückgegeben werden, die einem Wert in einem bestimmten Feld entsprechen. Das Feld kann einen beliebigen Typ haben.
Im Folgenden finden Sie Beispiele für die Verwendung von Kontextoperatoren auf Feldebene.
**`status:"Incomplete" AND financial_year:2021`**
Gibt Dokumente für das Geschäftsjahr 2021 mit dem Status „unvollständig“ zurück.
**`(sports OR recreation) AND country:"United States" AND level:"professional"`**
Gibt Dokumente zurück, die sich mit Profisport oder Freizeit in den Vereinigte Staaten.
#### Platzhalter
Sie können Ihre Suche erweitern, um Varianten von Wörtern und Ausdrücken zu berücksichtigen, indem Sie den Platzhalteroperator verwenden. Dies ist nützlich, wenn Sie nach Namensvarianten suchen. Amazon Kendra unterstützt derzeit nur nachfolgende Platzhalter. Die Anzahl der Präfixzeichen für einen Platzhalter am Ende muss größer als zwei sein.
Im Folgenden finden Sie Beispiele für die Verwendung von Platzhalteroperatoren.
**`Cloud*`**
Gibt Dokumente zurück, die Varianten wie CloudFormation und CloudWatch enthalten.
**`kendra*aws`**
Gibt Dokumente zurück, die Varianten wie kendra.amazonaws enthalten.
**`kendra*aws*`**
Gibt Dokumente zurück, die Varianten wie kendra.amazonaws.com enthalten
#### Genaue Zitate
Sie können Anführungszeichen verwenden, um nach einer exakten Übereinstimmung mit einem Text zu suchen.
Im Folgenden finden Sie Beispiele für die Verwendung von Anführungszeichen.
**`"Amazon Kendra" "pricing"`**
Gibt Dokumente zurück, die sowohl den Ausdruck '' als auch den Begriff Amazon Kendra'Preisgestaltung' enthalten. Dokumente müssen sowohl '' als auch Amazon Kendra'Preis' enthalten, damit die Ergebnisse zurückgegeben werden.
**`"Amazon Kendra" "pricing" cost`**
Gibt Dokumente zurück, die sowohl den Ausdruck 'Amazon Kendra' als auch den Begriff 'Preisgestaltung' und optional den Begriff 'Kosten' enthalten. Dokumente müssen sowohl „Amazon Kendra“ als auch „Preisgestaltung“ enthalten, damit die Ergebnisse zurückgegeben werden, müssen aber nicht unbedingt „Kosten“ enthalten.
#### Ungültige Abfragesyntax
Amazon Kendra gibt eine Warnung aus, wenn es Probleme mit Ihrer Abfragesyntax gibt oder Ihre Abfrage derzeit nicht unterstützt wird von Amazon Kendra. Weitere Informationen finden Sie in der [API-Dokumentation für Abfragewarnungen](https://docs.aws.amazon.com/kendra/latest/APIReference/API_Warning.html).
Die folgenden Abfragen sind Beispiele für eine ungültige Abfragesyntax.
**`_last_updated_at:<2021-12-32`**
Ungültiges Datum. Tag 32 existiert nicht im gregorianischen Kalender, der von verwendet wird. Amazon Kendra
**`_view_count:ten`**
Ungültiger numerischer Wert. Zahlen müssen verwendet werden, um numerische Werte darzustellen.
**`nonExistentField:123`**
Ungültige Feldsuche. Das Feld muss vorhanden sein, um die Feldsuche verwenden zu können.
**`Product:[A TO D]`**
Ungültiger Bereich. Numerische Werte oder Datumsangaben müssen für Bereiche verwendet werden.
**`OR Hello`**
Ungültiger boolescher Wert. Operatoren müssen zusammen mit Begriffen verwendet und zwischen Begriffen platziert werden.
## In Sprachen suchen
Sie können nach Dokumenten in einer unterstützten Sprache suchen. Sie übergeben den Sprachcode in, [AttributeFilter](https://docs.aws.amazon.com/kendra/latest/APIReference/API_AttributeFilter.html)um gefilterte Dokumente in der von Ihnen ausgewählten Sprache zurückzugeben. Sie können die Abfrage in einer unterstützten Sprache eingeben.
Wenn Sie keine Sprache angeben, werden Dokumente standardmäßig auf Englisch Amazon Kendra abgefragt. Weitere Informationen zu den unterstützten Sprachen, einschließlich ihrer Codes, finden Sie unter [Dokumente in anderen Sprachen als Englisch hinzufügen](https://docs.aws.amazon.com/kendra/latest/dg/in-adding-languages.html).
Um in der Konsole nach Dokumenten in einer unterstützten Sprache zu suchen, wählen Sie Ihren Index und dann im Navigationsmenü die Option zum Durchsuchen Ihres Index aus. Wählen Sie die Sprache aus, in der Sie Dokumente zurückgeben möchten, indem Sie die Sucheinstellungen und dann eine Sprache aus der Dropdownliste **Sprache** auswählen.
Die folgenden Beispiele zeigen, wie Sie auf Spanisch nach Dokumenten suchen können.
**Um in der Konsole nach einem Index auf Spanisch zu suchen**
1. Melden Sie sich bei der an AWS-Managementkonsole und öffnen Sie die Amazon Kendra Konsole unter [http://console.aws.amazon.com/kendra/](https://console.aws.amazon.com/kendra).
1. Wählen Sie im Navigationsmenü **Indizes** und wählen Sie Ihren Index aus.
1. Wählen Sie im Navigationsmenü die Option, um Ihren Index zu durchsuchen.
1. Wählen Sie in den Sucheinstellungen das Drop-down-Menü **Sprachen** aus und wählen Sie Spanisch aus.
1. Geben Sie eine Abfrage in das Textfeld ein und drücken Sie dann die Eingabetaste.
1. Amazon Kendra gibt die Ergebnisse der Suche auf Spanisch zurück.
**Um einen Index auf Spanisch mit der CLI, Python oder Java zu durchsuchen**
+ Im folgenden Beispiel wird ein Index auf Spanisch durchsucht. Ändern Sie `searchString` den Wert in Ihrer Suchabfrage und den Wert in `indexID` den Bezeichner des Indexes, den Sie durchsuchen möchten. Der Sprachcode für Spanisch lautet`es`. Sie können dies durch Ihren eigenen Sprachcode ersetzen.
------
#### [ CLI ]
```
{
"EqualsTo":{
"Key": "_language_code",
"Value": {
"StringValue": "es"
}
}
}
```
------
#### [ Python ]
```
import boto3
import pprint
kendra = boto3.client("kendra")
# Provide the index ID
index_id = "index-id"
# Provide the query text
query = "search-string"
# Includes the index ID, query text, and language attribute filter
response = kendra.query(
QueryText = query,
IndexId = index_id,
AttributeFilter = {
"EqualsTo": {
"Key": "_language_code",
"Value": {
"StringValue": "es"
}
}
})
print ("\nSearch results|Resultados de la búsqueda: " + query + "\n")
for query_result in response["ResultItems"]:
print("-------------------")
print("Type: " + str(query_result["Type"]))
if query_result["Type"]=="ANSWER" or query_result["Type"]=="QUESTION_ANSWER":
answer_text = query_result["DocumentExcerpt"]["Text"]
print(answer_text)
if query_result["Type"]=="DOCUMENT":
if "DocumentTitle" in query_result:
document_title = query_result["DocumentTitle"]["Text"]
print("Title: " + document_title)
document_text = query_result["DocumentExcerpt"]["Text"]
print(document_text)
print("------------------\n\n")
```
------
#### [ Java ]
```
package com.amazonaws.kendra;
import software.amazon.awssdk.services.kendra.KendraClient;
import software.amazon.awssdk.services.kendra.model.QueryRequest;
import software.amazon.awssdk.services.kendra.model.QueryResponse;
import software.amazon.awssdk.services.kendra.model.QueryResultItem;
public class SearchIndexExample {
public static void main(String[] args) {
KendraClient kendra = KendraClient.builder().build();
String query = "searchString";
String indexId = "indexID";
QueryRequest queryRequest = QueryRequest.builder()
.queryText(query)
.indexId(indexId)
.attributeFilter(
AttributeFilter.builder()
.withEqualsTo(
DocumentAttribute.builder()
.withKey("_language_code")
.withValue("es")
.build())
.build())
.build();
QueryResponse queryResponse = kendra.query(queryRequest);
System.out.println(String.format("\nSearch results|
Resultados de la búsqueda: %s", query));
for(QueryResultItem item: queryResponse.resultItems()) {
System.out.println("----------------------");
System.out.println(String.format("Type: %s", item.type()));
switch(item.type()) {
case QUESTION_ANSWER:
case ANSWER:
String answerText = item.documentExcerpt().text();
System.out.println(answerText);
break;
case DOCUMENT:
String documentTitle = item.documentTitle().text();
System.out.println(String.format("Title: %s", documentTitle));
String documentExcerpt = item.documentExcerpt().text();
System.out.println(String.format("Excerpt: %s", documentExcerpt));
break;
default:
System.out.println(String.format("Unknown query result type: %s", item.type()));
}
System.out.println("-----------------------\n");
}
}
}
```
------
# Passagen werden abgerufen
Sie können die [https://docs.aws.amazon.com/kendra/latest/APIReference/API_Retrieve.html](https://docs.aws.amazon.com/kendra/latest/APIReference/API_Retrieve.html)API als Retriever für Retrieval Augmented Generation (RAG) -Systeme verwenden.
RAG-Systeme verwenden generative künstliche Intelligenz, um Anwendungen zur Beantwortung von Fragen zu erstellen. RAG-Systeme bestehen aus einem Retriever und großen Sprachmodellen (LLM). Bei einer Anfrage identifiziert der Retriever die relevantesten Textblöcke aus einem Korpus von Dokumenten und leitet sie an das LLM weiter, um die nützlichste Antwort zu erhalten. Anschließend analysiert das LLM die relevanten Textblöcke oder Passagen und generiert eine umfassende Antwort auf die Anfrage.
Die `Retrieve` API betrachtet Textblöcke oder Auszüge, die als *Passagen bezeichnet werden, und gibt die wichtigsten Passagen* zurück, die für die Abfrage am relevantesten sind.
Wie die [https://docs.aws.amazon.com/kendra/latest/APIReference/API_Query.html](https://docs.aws.amazon.com/kendra/latest/APIReference/API_Query.html)API sucht auch die `Retrieve` API nach relevanten Informationen. Beim Informationsabruf der Retrieve API werden der Kontext der Abfrage und alle verfügbaren Informationen aus den indizierten Dokumenten berücksichtigt. Standardmäßig gibt die `Query` API jedoch nur Auszüge von bis zu 100 Stichwörtern zurück. Mit der `Retrieve` API können Sie längere Passagen mit bis zu 200 Token-Wörtern und bis zu 100 semantisch relevanten Passagen abrufen. Dies schließt keine Antworten vom Typ Frage-Antwort oder häufig gestellte Fragen aus Ihrem Index ein. Die Passagen, auch Chunks genannt, sind Textauszüge, die semantisch aus mehreren Dokumenten und mehreren Teilen desselben Dokuments extrahiert werden können. Der GenAI Enterprise Edition-Index von Kendra bietet hochgenaue Ergebnisse für den Abruf. Er verwendet eine hybride Suche über Vektor- und Schlüsselwortindizes sowie eine Rangfolge nach Deep-Learning-Modellen.
Mit der API können Sie auch Folgendes `Retrieve` tun:
+ Überschreiben Sie das Boosting auf Indexebene
+ Filtern Sie auf der Grundlage von Dokumentfeldern oder Attributen
+ Filtern Sie basierend auf dem Benutzer- oder Gruppenzugriff auf Dokumente
+ Sehen Sie sich den Bereich mit dem Konfidenzwert für ein abgerufenes Passageergebnis an. Das Konfidenzfeld bietet eine relative Rangfolge, die angibt, wie sicher Amazon Kendra es ist, dass die Antwort für die Abfrage relevant ist.
**Anmerkung**
Buckets mit Konfidenzwerten sind derzeit nur für Englisch verfügbar.
Sie können der Antwort auch bestimmte Felder hinzufügen, die möglicherweise nützliche Zusatzinformationen enthalten.
[Die `Retrieve` API unterstützt derzeit die folgenden Funktionen nicht: Abfragen mit erweiterter [Abfragesyntax](https://docs.aws.amazon.com/kendra/latest/dg/searching-example.html#searching-index-query-syntax), [vorgeschlagene Rechtschreibkorrekturen](https://docs.aws.amazon.com/kendra/latest/dg/query-spell-check.html) für Abfragen, [Facettierung](https://docs.aws.amazon.com/kendra/latest/dg/filtering.html#search-facets), [Abfragevorschläge](https://docs.aws.amazon.com/kendra/latest/dg/query-suggestions.html) zur automatischen Vervollständigung von Suchanfragen und inkrementelles Lernen.](https://docs.aws.amazon.com/kendra/latest/dg/submitting-feedback.html) Abfragen zum Abrufen der API werden nicht im Analyse-Dashboard angezeigt.
Die `Retrieve` API teilt sich die Anzahl der [Abfragekapazitätseinheiten](https://docs.aws.amazon.com/kendra/latest/APIReference/API_CapacityUnitsConfiguration.html), die Sie für Ihren Index festgelegt haben. Weitere Informationen darüber, was in einer einzelnen Kapazitätseinheit enthalten ist, und zur Standard-Basiskapazität für einen Index finden Sie unter [Kapazität anpassen](https://docs.aws.amazon.com/kendra/latest/dg/adjusting-capacity.html).
**Anmerkung**
Sie können keine Kapazität hinzufügen, wenn Sie die Amazon Kendra Developer Edition verwenden. Sie können Kapazität nur hinzufügen, wenn Sie die Amazon Kendra Enterprise Edition verwenden. Weitere Informationen darüber, was in der Developer Edition und der Enterprise Edition enthalten ist, finden Sie unter [Amazon Kendra Editionen](https://docs.aws.amazon.com/kendra/latest/dg/what-is-kendra.html#kendra-editions).
Im Folgenden finden Sie ein Beispiel für die Verwendung der `Retrieve` API, um die 100 relevantesten Passagen aus Dokumenten in einem Index für die Abfrage abzurufen "how does amazon kendra work?"
------
#### [ Python ]
```
import boto3
import pprint
kendra = boto3.client("kendra")
# Provide the index ID
index_id = "index-id"
# Provide the query text
query = "how does amazon kendra work?"
# You can retrieve up to 100 relevant passages
# You can paginate 100 passages across 10 pages, for example
page_size = 10
page_number = 10
result = kendra.retrieve(
IndexId = index_id,
QueryText = query,
PageSize = page_size,
PageNumber = page_number)
print("\nRetrieved passage results for query: " + query + "\n")
for retrieve_result in result["ResultItems"]:
print("-------------------")
print("Title: " + str(retrieve_result["DocumentTitle"]))
print("URI: " + str(retrieve_result["DocumentURI"]))
print("Passage content: " + str(retrieve_result["Content"]))
print("------------------\n\n")
```
------
#### [ Java ]
```
package com.amazonaws.kendra;
import software.amazon.awssdk.services.kendra.KendraClient;
import software.amazon.awssdk.services.kendra.model.RetrieveRequest;
import software.amazon.awssdk.services.kendra.model.RetrieveResult;
import software.amazon.awssdk.services.kendra.model.RetrieveResultItem;
public class RetrievePassageExample {
public static void main(String[] args) {
KendraClient kendra = KendraClient.builder().build();
String indxId = "index-id";
String query = "how does amazon kendra work?";
Integer pgSize = 10;
Integer pgNumber = 10;
RetrieveRequest retrieveRequest = retrieveRequest
.builder()
.indexId(indxId)
.queryText(query)
.pageSize(pgSize)
.pageNumber(pgNumber)
.build();
RetrieveResult retrieveResult = kendra.retrieve(retrieveRequest);
System.out.println(String.format("\nRetrieved passage results for query: %s", query));
for(RetrieveResultItem item: retrieveResult.resultItems()) {
System.out.println("----------------------");
System.out.println(String.format("Title: %s", documentTitle));
System.out.println(String.format("URI: %s", documentURI));
System.out.println(String.format("Passage content: %s", content));
System.out.println("-----------------------\n");
}
}
}
```
------
# Einen Index durchsuchen
**Anmerkung**
Die Funktionsunterstützung variiert je nach Indextyp und verwendeter Such-API. Informationen darüber, ob diese Funktion für den von Ihnen verwendeten Indextyp und die Such-API unterstützt wird, finden Sie unter [Indextypen](https://docs.aws.amazon.com/kendra/latest/dg/hiw-index-types.html).
Sie können Dokumente nach ihren Attributen oder Facetten durchsuchen, ohne eine Suchabfrage eingeben zu müssen. Amazon Kendra *Index Browse* kann Ihren Benutzern helfen, Dokumente zu finden, indem sie einen Index frei durchsuchen, ohne eine bestimmte Abfrage im Hinterkopf zu haben. Dies hilft Ihren Benutzern auch dabei, einen Index als Ausgangspunkt für ihre Suche umfassend zu durchsuchen.
Die Indexsuche kann nur für die Suche nach einem Dokumentattribut oder einer Facette mit einem Sortiertyp verwendet werden. Mit der Indexsuche können Sie nicht einen gesamten Index durchsuchen. Wenn der Abfragetext fehlt, werden Sie Amazon Kendra nach einem Dokumentattributfilter oder einer Facette und einem Sortiertyp gefragt.
Um das Durchsuchen von Indizes mithilfe der [Abfrage-API](https://docs.aws.amazon.com/kendra/latest/APIReference/API_Query.html) zu ermöglichen, müssen Sie [AttributeFilter](https://docs.aws.amazon.com/kendra/latest/APIReference/API_AttributeFilter.html)oder [Facet und angeben](https://docs.aws.amazon.com/kendra/latest/APIReference/API_Facet.html). [SortingConfiguration](https://docs.aws.amazon.com/kendra/latest/APIReference/API_SortingConfiguration.html) Um das Durchsuchen von Indizes in der Konsole zu ermöglichen, wählen Sie im Navigationsmenü unter **Indizes** Ihren Index aus und wählen Sie dann die Option, Ihren Index zu durchsuchen. Drücken Sie im Suchfeld zweimal die *Eingabetaste*. Wählen Sie die Dropdownliste **Suchergebnisse filtern** aus, um einen Filter auszuwählen, und wählen Sie die Dropdownliste **Sortieren** aus, um einen Sortierungstyp auszuwählen.
Im Folgenden finden Sie ein Beispiel für das Durchsuchen eines Indexes nach Dokumenten in der Sprache Spanisch in absteigender Reihenfolge des Erstellungsdatums des Dokuments.
------
#### [ CLI ]
```
aws kendra query \
--index-id "index-id" \
--attribute-filter '{
"EqualsTo":{
"Key": "_language_code",
"Value": {
"StringValue": "es"
}
}
}' \
--sorting-configuration '{
"DocumentAttributeKey": "_created_at",
"SortOrder": "DESC"
}'
```
------
#### [ Python ]
```
import boto3
kendra = boto3.client("kendra")
# Must include the index ID, the attribute filter, and sorting configuration
response = kendra.query(
IndexId = "index-id",
AttributeFilter = {
"EqualsTo": {
"Key": "_language_code",
"Value": {
"StringValue": "es"
}
}
},
SortingConfiguration = {
"DocumentAttributeKey": "_created_at",
"SortOrder": "DESC"})
print("\nSearch results|Resultados de la búsqueda: \n")
for query_result in response["ResultItems"]:
print("-------------------")
print("Type: " + str(query_result["Type"]))
if query_result["Type"]=="ANSWER" or query_result["Type"]=="QUESTION_ANSWER":
answer_text = query_result["DocumentExcerpt"]["Text"]
print(answer_text)
if query_result["Type"]=="DOCUMENT":
if "DocumentTitle" in query_result:
document_title = query_result["DocumentTitle"]["Text"]
print("Title: " + document_title)
document_text = query_result["DocumentExcerpt"]["Text"]
print(document_text)
print("------------------\n\n")
```
------
#### [ Java ]
```
package com.amazonaws.kendra;
import software.amazon.awssdk.services.kendra.KendraClient;
import software.amazon.awssdk.services.kendra.model.QueryRequest;
import software.amazon.awssdk.services.kendra.model.QueryResult;
import software.amazon.awssdk.services.kendra.model.QueryResultItem;
public class SearchIndexExample {
public static void main(String[] args) {
KendraClient kendra = KendraClient.builder().build();
QueryRequest queryRequest = QueryRequest.builder()
.withIndexId("index-id")
.withAttributeFilter(AttributeFilter.builder()
.withEqualsTo(DocumentAttribute.builder()
.withKey("_language_code")
.withValue(DocumentAttributeValue.builder()
.withStringValue("es")
.build())
.build())
.build())
.withSortingConfiguration(SortingConfiguration.builder()
.withDocumentAttributeKey("_created_at")
.withSortOrder("DESC")
.build())
.build());
QueryResult queryResult = kendra.query(queryRequest);
for (QueryResultItem item : queryResult.getResultItems()) {
System.out.println("----------------------");
System.out.println(String.format("Type: %s", item.getType()));
switch (item.getType()) {
case QueryResultType.QUESTION_ANSWER:
case QueryResultType.ANSWER:
String answerText = item.getDocumentExcerpt().getText();
System.out.println(answerText);
break;
case QueryResultType.DOCUMENT:
String documentTitle = item.getDocumentTitle().getText();
System.out.println(String.format("Title: %s", documentTitle));
String documentExcerpt = item.getDocumentExcerpt().getText();
System.out.println(String.format("Excerpt: %s", documentExcerpt));
break;
default:
System.out.println(String.format("Unknown query result type: %s", item.getType()));
}
System.out.println("-----------------------\n");
}
}
}
```
------
# Mit Suchergebnissen
**Anmerkung**
Die Funktionsunterstützung variiert je nach Indextyp und verwendeter Such-API. Informationen darüber, ob diese Funktion für den von Ihnen verwendeten Indextyp und die Such-API unterstützt wird, finden Sie unter [Indextypen](https://docs.aws.amazon.com/kendra/latest/dg/hiw-index-types.html).
Sie können bestimmte Dokumente in den Suchergebnissen angeben, wenn Ihre Benutzer bestimmte Abfragen stellen. Dies trägt dazu bei, dass die Ergebnisse für Ihre Benutzer sichtbarer und prominenter werden. Ausgewählte Ergebnisse werden von der üblichen Ergebnisliste getrennt und oben auf der Suchseite angezeigt. Sie können damit experimentieren, verschiedene Dokumente für verschiedene Suchanfragen zu präsentieren, oder sicherstellen, dass bestimmte Dokumente die Sichtbarkeit erhalten, die sie verdienen.
Sie ordnen bestimmte Abfragen bestimmten Dokumenten zu, damit sie in den Ergebnissen angezeigt werden. Wenn eine Abfrage eine exakte Übereinstimmung enthält, werden ein oder mehrere spezifische Dokumente in den Suchergebnissen aufgeführt.
Sie können beispielsweise festlegen, dass, wenn Ihre Benutzer die Abfrage „Neue Produkte 2023“ stellen, dann die Dokumente mit den Titeln „Was ist neu“ und „In Kürze verfügbar“ auswählen, die oben auf der Suchergebnisseite angezeigt werden sollen. Dadurch wird sichergestellt, dass diese Dokumente zu neuen Produkten die Aufmerksamkeit erhalten, die sie verdienen.
Amazon Kendra dupliziert keine Suchergebnisse, wenn ein Ergebnis bereits ausgewählt wurde, das oben auf der Suchergebnisseite angezeigt werden soll. Ein hervorgehobenes Ergebnis wird nicht erneut als erstes Ergebnis eingestuft, wenn es bereits vor allen anderen Ergebnissen angezeigt wird.
Um bestimmte Ergebnisse anzuzeigen, müssen Sie eine exakte Übereinstimmung mit einer Volltextabfrage angeben, nicht eine teilweise Übereinstimmung mit einer Abfrage, bei der ein Schlüsselwort oder eine Wortgruppe verwendet wird, die in einer Abfrage enthalten ist. Wenn Sie beispielsweise nur die Abfrage „Kendra“ in einer Ergebnismenge angeben, sind Abfragen wie „Wie ordnet Kendra Ergebnisse semantisch ein?“ rendert die ausgewählten Ergebnisse nicht. Ausgewählte Ergebnisse sind für spezifische Abfragen konzipiert und nicht für Abfragen, deren Umfang zu umfangreich ist. Amazon Kendra verarbeitet auf natürliche Weise Abfragen vom Typ Schlüsselwort, um die nützlichsten Dokumente in den Suchergebnissen zu ordnen und so zu vermeiden, dass Ergebnisse, die auf einfachen Schlüsselwörtern basieren, übermäßig dargestellt werden.
Wenn es bestimmte Abfragen gibt, die Ihre Benutzer häufig verwenden, können Sie diese Abfragen für besonders beliebte Ergebnisse spezifizieren. Wenn Sie sich beispielsweise mithilfe von [Amazon Kendra Analytics](https://docs.aws.amazon.com/kendra/latest/dg/search-analytics.html) Ihre häufigsten Suchanfragen ansehen und dabei bestimmte Abfragen finden, z. B. „Wie ordnet Kendra Ergebnisse semantisch ein?“ und „Semantische Kendra-Suche“ werden häufig verwendet, dann kann es nützlich sein, diese Abfragen zu spezifizieren, um das Dokument mit dem Titel „Suche 101“ anzuzeigen.Amazon Kendra
Amazon Kendra behandelt Abfragen nach ausgewählten Ergebnissen ohne Berücksichtigung der Groß- und Kleinschreibung. Amazon Kendra wandelt eine Abfrage in Kleinbuchstaben um und ersetzt nachfolgende Leerzeichen durch ein einzelnes Leerzeichen. Amazon Kendra entspricht allen anderen Zeichen so, wie sie sind, wenn Sie Ihre Abfragen für herausragende Ergebnisse angeben.
Sie erstellen eine Reihe von ausgewählten Ergebnissen, die Sie mithilfe der [CreateFeaturedResultsSet](https://docs.aws.amazon.com/kendra/latest/APIReference/API_CreateFeaturedResultsSet.html)API bestimmten Abfragen zuordnen. Wenn Sie die Konsole verwenden, wählen Sie Ihren Index aus und wählen dann im Navigationsmenü die Option **Ausgewählte Ergebnisse** aus, um einen Satz mit ausgewählten Ergebnissen zu erstellen. Sie können bis zu 50 Gruppen von ausgewählten Ergebnissen pro Index, bis zu vier Dokumente, die pro Satz vorgestellt werden sollen, und bis zu 49 Abfragetexte pro Satz von ausgewählten Ergebnissen erstellen. Sie können eine Erhöhung dieser Limits beantragen, indem Sie sich an den [Support](https://aws.amazon.com/contact-us/) wenden.
Sie können dasselbe Dokument aus mehreren Gruppen von ausgewählten Ergebnissen auswählen. Sie dürfen jedoch nicht denselben Abfragetext mit exakt übereinstimmender Übereinstimmung in mehreren Sätzen verwenden. Die Abfragen, die Sie für hervorgehobene Ergebnisse angeben, müssen pro ausgewähltem Ergebnissatz für jeden Index eindeutig sein.
Sie können die Reihenfolge der Dokumente festlegen, wenn Sie bis zu vier ausgewählte Dokumente auswählen. Wenn Sie die API verwenden, entspricht die Reihenfolge, in der Sie die ausgewählten Dokumente auflisten, der in den ausgewählten Ergebnissen angezeigten Reihenfolge. Wenn Sie die Konsole verwenden, können Sie die Reihenfolge der Dokumente einfach per Drag-and-Drop verschieben, wenn Sie Dokumente auswählen, die in den Ergebnissen angezeigt werden sollen.
Die Zugriffskontrolle, bei der bestimmte Benutzer und Gruppen Zugriff auf bestimmte Dokumente haben und andere nicht, wird bei der Konfiguration von ausgewählten Ergebnissen weiterhin berücksichtigt. Das gilt auch für die Filterung von Benutzerkontexten. Beispielsweise gehört Benutzer A zur Unternehmensgruppe „Praktikanten“, die nicht auf Dokumente zu Unternehmensgeheimnissen zugreifen sollte. Wenn Benutzer A eine Abfrage eingibt, die ein Dokument mit einem Unternehmensgeheimnis enthält, sieht Benutzer A dieses Dokument nicht in seinen Ergebnissen. Das gilt auch für alle anderen Ergebnisse auf der Suchergebnisseite. Sie können Tags auch verwenden, um den Zugriff auf einen Ergebnissatz mit ausgewählten Ergebnissen zu steuern. Dabei handelt es sich um eine Amazon Kendra Ressource, für die Sie den Zugriff kontrollieren.
Im Folgenden finden Sie ein Beispiel für die Erstellung einer Reihe von ausgewählten Ergebnissen mit den Abfragen „Neue Produkte 2023" und „Neue Produkte verfügbar“, die den Dokumenten mit den Titeln „Was ist neu“ (doc-id-1) und „Demnächst“ (doc-id-2) zugeordnet sind.
------
#### [ CLI ]
```
aws kendra create-featured-results-set \
--featured-results-set-name 'New product docs to feature' \
--description "Featuring What's new and Coming soon docs" \
--index-id index-id \
--query-texts 'new products 2023' 'new products available' \
--featured-documents '{"Id":"doc-id-1", "Id":"doc-id-2"}'
```
------
#### [ Python ]
```
import boto3
from botocore.exceptions import ClientError
import pprint
import time
kendra = boto3.client("kendra")
print("Create a featured results set.")
# Provide a name for the featured results set
featured_results_name = "New product docs to feature"
# Provide an optional decription for the featured results set
description = "Featuring What's new and Coming soon docs"
# Provide the index ID for the featured results set
index = "index-id"
# Provide a list of query texts for the featured results set
queries = ['new products 2023', 'new products available']
# Provide a list of document IDs for the featured results set
featured_doc_ids = [{"Id":"doc-id-1"}, {"Id":"doc-id-2"}]
try:
featured_results_set_response = kendra.create_featured_results_set(
FeaturedResultsSetName = featured_results_name,
Decription = description,
Index = index,
QueryTexts = queries,
FeaturedDocuments = featured_doc_ids
)
pprint.pprint(featured_results_set_response)
featured_results_set_id = featured_results_set_response["FeaturedResultsSetId"]
while True:
# Get the details of the featured results set, such as the status
featured_results_set_description = kendra.describe_featured_results_set(
Id = featured_results_set_id
)
status = featured_results_set_description["Status"]
print(" Featured results set status: "+status)
except ClientError as e:
print("%s" % e)
print("Program ends.")
```
------
# Tabellarische Suche nach HTML
**Anmerkung**
Die Funktionsunterstützung variiert je nach Indextyp und verwendeter Such-API. Informationen darüber, ob diese Funktion für den von Ihnen verwendeten Indextyp und die Such-API unterstützt wird, finden Sie unter [Indextypen](https://docs.aws.amazon.com/kendra/latest/dg/hiw-index-types.html).
Amazon Kendra Die tabellarische Suchfunktion kann Antworten aus Tabellen suchen und extrahieren, die in HTML-Dokumente eingebettet sind. Wenn Sie Ihren Index durchsuchen, Amazon Kendra fügt sie einen Auszug aus einer Tabelle hinzu, sofern dieser für die Abfrage relevant ist, und liefert nützliche Informationen.
Amazon Kendra durchsucht alle Informationen im Haupttext eines Dokuments, einschließlich nützlicher Informationen in Tabellen. Ein Index enthält beispielsweise Geschäftsberichte mit Tabellen zu Betriebskosten, Einnahmen und anderen Finanzinformationen. Für die Abfrage „Wie hoch sind die jährlichen Betriebskosten von 2020-2022?“ , Amazon Kendra kann einen Auszug aus einer Tabelle zurückgeben, die die relevanten Tabellenspalten „Operationen (Millionen USD)“ und „Geschäftsjahr“ sowie Tabellenzeilen mit Einkommenswerten für 2020, 2021 und 2022 enthält. Der Tabellenauszug ist zusammen mit dem Dokumenttitel, einem Link zum vollständigen Dokument und allen anderen Dokumentfeldern, die Sie einbeziehen möchten, im Ergebnis enthalten.
Tabellenauszüge können in den Suchergebnissen angezeigt werden, unabhängig davon, ob sich die Informationen in einer Zelle einer Tabelle oder in mehreren Zellen befinden. Amazon Kendra Kann beispielsweise einen Tabellenauszug anzeigen, der auf jede dieser Arten von Abfragen zugeschnitten ist:
+ „Kreditkarte mit dem höchsten Zinssatz im Jahr 2020"
+ „Kreditkarte mit dem höchsten Zinssatz von 2020-2022"
+ „Top 3 Kreditkarten mit dem höchsten Zinssatz in den Jahren 2020-2022"
+ „Kreditkarten mit Zinssätzen von weniger als 10%“
+ „alle verfügbaren zinsgünstigen Kreditkarten“
Amazon Kendra hebt die Tabellenzelle oder -zellen hervor, die für die Abfrage am relevantesten sind. Die relevantesten Zellen mit den entsprechenden Zeilen, Spalten und Spaltennamen werden im Suchergebnis angezeigt. Der Tabellenauszug zeigt bis zu fünf Spalten und drei Zeilen an, je nachdem, wie viele Tabellenzellen für die Abfrage relevant sind und wie viele Spalten in der Originaltabelle verfügbar sind. Die oberste relevanteste Zelle wird im Tabellenauszug zusammen mit den nächstrelevantesten Zellen angezeigt.
Die Antwort enthält den Konfidenzbereich (`MEDIUM`,`HIGH`,`VERY_HIGH`), der zeigt, wie relevant die Tabellenantwort für die Abfrage ist. Wenn ein Wert `VERY_HIGH` in einer Tabellenzelle vertraulich ist, wird er als „Antwort am häufigsten“ eingestuft und hervorgehoben. Vertrauliche Tabellenzellenwerte werden `HIGH` hervorgehoben. Bei vertraulichen Tabellenzellenwerten werden sie nicht hervorgehoben. `MEDIUM` Die Gesamtsicherheit für die Tabellenantwort wird in der Antwort zurückgegeben. Wenn eine Tabelle beispielsweise hauptsächlich Tabellenzellen mit `HIGH` Konfidenz enthält, dann ist die Gesamtkonfidenz, die in der Antwort für die Tabellenantwort zurückgegeben wird, `HIGH` Konfidenz.
Standardmäßig wird Tabellen kein höheres Maß an Wichtigkeit oder Gewicht beigemessen als anderen Komponenten eines Dokuments. Wenn innerhalb eines Dokuments eine Tabelle für eine Abfrage nur geringfügig relevant ist, es aber einen Absatz mit hoher Relevanz gibt, wird ein Auszug aus dem Absatz Amazon Kendra zurückgegeben. In den Suchergebnissen wird der Inhalt angezeigt, der die bestmögliche Antwort und die nützlichsten Informationen bietet, und zwar im selben Dokument oder in anderen Dokumenten. Wenn die Konfidenz für eine Tabelle unter `MEDIUM` das Konfidenzniveau fällt, wird der Tabellenauszug in der Antwort nicht zurückgegeben.
Um die tabellarische Suche für einen vorhandenen Index zu verwenden, müssen Sie Ihren Inhalt neu indizieren.
Amazon Kendra Die tabellarische Suche unterstützt [Synonyme](https://docs.aws.amazon.com/kendra/latest/dg/index-synonyms.html) (einschließlich benutzerdefinierter Synonyme). Amazon Kendra unterstützt nur englische Dokumente mit HTML-Tabellen, die sich innerhalb des Tabellen-Tags befinden.
Das folgende Beispiel zeigt einen Tabellenauszug, der im Abfrageergebnis enthalten ist. Ein JSON-Beispiel mit Abfrageantworten, einschließlich Tabellenauszügen, finden Sie unter [Abfrageantworten und Typen](https://docs.aws.amazon.com/kendra/latest/dg/query-responses-types.html).
------
#### [ Python ]
```
import boto3
import pprint
kendra = boto3.client("kendra")
# Provide the index ID
index_id =
# Provide the query text
query = "search string"
response = kendra.query(
QueryText = query,
IndexId = index_id)
print("\nSearch results for query: " + query + "\n")
for query_result in response["ResultItems"]:
print("-------------------")
print("Type: " + str(query_result["Type"]))
print("Type: " + str(query_result["Format"]))
if query_result["Type"]=="ANSWER" and query_result["Format"]=="TABLE":
answer_table = query_result["TableExcerpt"]
print(answer_table)
if query_result["Type"]=="ANSWER" and query_result["Format"]=="TEXT":
answer_text = query_result["DocumentExcerpt"]
print(answer_text)
if query_result["Type"]=="QUESTION_ANSWER":
question_answer_text = query_result["DocumentExcerpt"]["Text"]
print(question_answer_text)
if query_result["Type"]=="DOCUMENT":
if "DocumentTitle" in query_result:
document_title = query_result["DocumentTitle"]["Text"]
print("Title: " + document_title)
document_text = query_result["DocumentExcerpt"]["Text"]
print(document_text)
print("------------------\n\n")
```
------
#### [ Java ]
```
package com.amazonaws.kendra;
import software.amazon.awssdk.services.kendra.KendraClient;
import software.amazon.awssdk.services.kendra.model.QueryRequest;
import software.amazon.awssdk.services.kendra.model.QueryResponse;
import software.amazon.awssdk.services.kendra.model.QueryResultItem;
public class SearchIndexExample {
public static void main(String[] args) {
KendraClient kendra = KendraClient.builder().build();
String query = "search string";
String indexId = "index-id";
QueryRequest queryRequest = QueryRequest
.builder()
.queryText(query)
.indexId(indexId)
.build();
QueryResponse queryResponse = kendra.query(queryRequest);
System.out.println(String.format("\nSearch results for query: %s", query));
for(QueryResultItem item: queryResponse.resultItems()) {
System.out.println("----------------------");
System.out.println(String.format("Type: %s", item.type()));
System.out.println(String.format("Format: %s", item.format()));
switch(item.format()) {
case TABLE:
String answerTable = item.TableExcerpt();
System.out.println(answerTable);
break;
}
switch(item.format()) {
case TEXT:
String answerText = item.DocumentExcerpt();
System.out.println(answerText);
break;
}
switch(item.type()) {
case QUESTION_ANSWER:
String questionAnswerText = item.documentExcerpt().text();
System.out.println(questionAnswerText);
break;
case DOCUMENT:
String documentTitle = item.documentTitle().text();
System.out.println(String.format("Title: %s", documentTitle));
String documentExcerpt = item.documentExcerpt().text();
System.out.println(String.format("Excerpt: %s", documentExcerpt));
break;
default:
System.out.println(String.format("Unknown query result type: %s", item.type()));
}
System.out.println("-----------------------\n");
}
}
}
```
------
# Vorschläge für Abfragen
**Anmerkung**
Die Funktionsunterstützung variiert je nach Indextyp und verwendeter Such-API. Informationen darüber, ob diese Funktion für den von Ihnen verwendeten Indextyp und die Such-API unterstützt wird, finden Sie unter [Indextypen](https://docs.aws.amazon.com/kendra/latest/dg/hiw-index-types.html).
Amazon Kendra Mit *Abfragevorschlägen* können Ihre Benutzer ihre Suchanfragen schneller eingeben und sie bei der Suche unterstützen.
Amazon Kendra schlägt Anfragen vor, die für Ihre Benutzer relevant sind, und zwar auf der Grundlage einer der folgenden Kriterien:
+ Beliebte Abfragen im Abfrageverlauf oder im Abfrageprotokoll
+ Der Inhalt von Feldern/Attributen des Dokuments
Sie können Ihre Präferenz für die Verwendung des Abfrageverlaufs oder der Dokumentfelder festlegen, indem Sie entweder auf `QUERY` oder setzen `SuggestionTypes` `DOCUMENT_ATTRIBUTES` und dann aufrufen. [https://docs.aws.amazon.com/kendra/latest/APIReference/API_GetQuerySuggestions.html](https://docs.aws.amazon.com/kendra/latest/APIReference/API_GetQuerySuggestions.html) Amazon Kendra Verwendet standardmäßig den Abfrageverlauf als Grundlage für Vorschläge. Wenn sowohl der Abfrageverlauf als auch die Dokumentfelder beim Aufrufen aktiviert sind [https://docs.aws.amazon.com/kendra/latest/APIReference/API_UpdateQuerySuggestionsConfig.html](https://docs.aws.amazon.com/kendra/latest/APIReference/API_UpdateQuerySuggestionsConfig.html)und Sie Ihre `SuggestionTypes` Präferenz für die Verwendung von Dokumentfeldern nicht festgelegt haben, wird der Abfrageverlauf Amazon Kendra verwendet.
Wenn Sie die Konsole verwenden, können Sie Abfragevorschläge entweder auf dem Abfrageverlauf oder auf Dokumentfeldern basieren. Sie wählen zuerst Ihren Index aus und wählen dann im Navigationsmenü unter Erweiterungen **die Option** **Abfragevorschläge** aus. Wählen Sie dann **Abfragevorschläge konfigurieren** aus. Nachdem Sie Abfragevorschläge konfiguriert haben, werden Sie zu einer Suchkonsole weitergeleitet, in der Sie entweder die **Felder **Abfrageverlauf** oder Dokument** im rechten Bereich auswählen und eine Suchabfrage in die Suchleiste eingeben können.
Standardmäßig werden Abfragevorschläge, die den Abfrageverlauf und die Dokumentfelder verwenden, beide ohne zusätzliche Kosten aktiviert. Sie können diese Art von Abfragevorschlägen jederzeit mithilfe der `UpdateQuerySuggestionsConfig` API deaktivieren. Um Abfragevorschläge zu deaktivieren, die auf dem Abfrageverlauf basieren, stellen Sie `DISABLED` beim Aufrufen `Mode` auf ein`UpdateQuerySuggestionsConfig`. Um auf Dokumentfeldern basierende Abfragevorschläge `AttributeSuggestionsMode` zu deaktivieren, stellen Sie `INACTIVE` in der Konfiguration der Dokumentfelder auf ein und rufen Sie dann auf`UpdateQuerySuggestionsConfig>`. Wenn Sie die Konsole verwenden, können Sie Abfragevorschläge in den **Einstellungen für Abfragevorschläge** deaktivieren.
Bei Abfragevorschlägen wird nicht zwischen Groß- und Kleinschreibung unterschieden. Amazon Kendra wandelt das Abfragepräfix und die vorgeschlagene Abfrage in Kleinbuchstaben um, ignoriert alle einfachen und doppelten Anführungszeichen und ersetzt mehrere Leerzeichen durch ein einzelnes Leerzeichen. Amazon Kendra entspricht allen anderen Sonderzeichen, wie sie sind. Amazon Kendra zeigt keine Vorschläge an, wenn ein Benutzer weniger als zwei Zeichen oder mehr als 60 Zeichen eingibt.
**Topics**
+ [
## Fragen Sie Vorschläge mithilfe des Abfrageverlaufs ab
](#query-suggestions-history)
+ [
## Fragen Sie Vorschläge mithilfe von Dokumentfeldern ab
](#query-suggestions-doc-fields)
+ [
## Sperren Sie bestimmte Abfragen oder dokumentieren Sie Feldinhalte aus Vorschlägen
](#query-suggestions-blocklist)
## Fragen Sie Vorschläge mithilfe des Abfrageverlaufs ab
**Anmerkung**
Die Funktionsunterstützung variiert je nach Indextyp und verwendeter Such-API. Informationen darüber, ob diese Funktion für den von Ihnen verwendeten Indextyp und die Such-API unterstützt wird, finden Sie unter [Indextypen](https://docs.aws.amazon.com/kendra/latest/dg/hiw-index-types.html).
**Topics**
+ [
### Einstellungen für die Auswahl von Abfragen für Vorschläge
](#query-suggestions-history-settings)
+ [
### Vorschläge löschen und gleichzeitig den Abfrageverlauf beibehalten
](#query-suggestions-history-clear)
+ [
### Keine Vorschläge verfügbar
](#query-suggestions-history-none)
Sie können wählen, ob Sie Abfragen vorschlagen möchten, die für Ihre Benutzer relevant sind, und zwar auf der Grundlage häufig verwendeter Abfragen im Abfrageverlauf oder im Abfrageprotokoll. Amazon Kendra verwendet alle Abfragen, nach denen Ihre Benutzer suchen, und lernt aus diesen Abfragen, um Ihren Benutzern Vorschläge zu unterbreiten. Amazon Kendra schlägt Benutzern beliebte Abfragen vor, wenn sie mit der Eingabe ihrer Anfrage beginnen. Amazon Kendra schlägt eine Abfrage vor, wenn das Präfix oder die ersten Zeichen der Abfrage mit dem übereinstimmen, was der Benutzer als Abfrage eingibt.
Ein Benutzer beginnt beispielsweise mit der Eingabe der Abfrage „bevorstehende Ereignisse“. Amazon Kendra hat aus dem Abfrageverlauf erfahren, dass viele Benutzer viele Male nach „bevorstehende Ereignisse 2050“ gesucht haben. Der Benutzer sieht, dass „bevorstehende Ereignisse 2050“ direkt unter seiner Suchleiste angezeigt werden, wodurch seine Suchabfrage automatisch vervollständigt wird. Der Benutzer wählt diesen Abfragevorschlag aus und das Dokument „Neue Ereignisse: Was passiert in 2050“ wird in den Suchergebnissen angezeigt.
Sie können angeben, wie geeignete Abfragen Amazon Kendra ausgewählt werden, um Ihren Benutzern vorzuschlagen. Sie können beispielsweise angeben, dass ein Abfragevorschlag von mindestens 10 eindeutigen Benutzern (Standard ist drei) durchsucht worden sein muss, dass er innerhalb der letzten 30 Tage durchsucht wurde und dass er keine Wörter oder Ausdrücke aus Ihrer [Sperrliste](https://docs.aws.amazon.com/kendra/latest/dg/query-suggestions.html#query-suggestions-blocklist) enthält. Amazon Kendra erfordert, dass eine Abfrage mindestens ein Suchergebnis hat und mindestens ein Wort mit mehr als vier Zeichen enthält.
### Einstellungen für die Auswahl von Abfragen für Vorschläge
Sie können die folgenden Einstellungen für die Auswahl von Abfragen für Vorschläge mithilfe der [https://docs.aws.amazon.com/kendra/latest/APIReference/API_UpdateQuerySuggestionsConfig.html](https://docs.aws.amazon.com/kendra/latest/APIReference/API_UpdateQuerySuggestionsConfig.html)API konfigurieren:
+ **Modus** — Abfragevorschläge, die den Abfrageverlauf verwenden, sind entweder `ENABLED` oder`LEARN_ONLY`. Amazon Kendra aktiviert standardmäßig Abfragevorschläge. `LEARN_ONLY`deaktiviert Abfragevorschläge. Ist diese Option deaktiviert, lernt Amazon Kendra weiterhin Vorschläge, unterbreitet Benutzern jedoch keine Abfragevorschläge.
+ **Zeitfenster für die Abfrageprotokollierung** — Gibt an, wie aktuell Ihre Abfragen in Ihrem Zeitfenster für die Abfrageprotokollierung sind. Das Zeitfenster ist ein ganzzahliger Wert für die Anzahl der Tage vom aktuellen Tag bis zu den vergangenen Tagen.
+ **Abfragen ohne Benutzerinformationen — Wählen** Sie diese Option aus, `TRUE` um alle Abfragen einzubeziehen, oder legen Sie fest, `FALSE` dass nur Abfragen mit Benutzerinformationen eingeschlossen werden. Sie können diese Einstellung verwenden, wenn Ihre Suchanwendung Benutzerinformationen wie die Benutzer-ID enthält, wenn ein Benutzer eine Abfrage ausgibt. Standardmäßig filtert diese Einstellung keine Abfragen heraus, wenn den Abfragen keine spezifischen Benutzerinformationen zugeordnet sind. Sie können diese Einstellung jedoch verwenden, um nur Vorschläge zu unterbreiten, die auf Abfragen basieren, die Benutzerinformationen enthalten.
+ **Eindeutige Benutzer** — Die Mindestanzahl an eindeutigen Benutzern, die eine Abfrage durchsuchen müssen, um sie Ihren Benutzern vorschlagen zu können. Diese Zahl ist ein ganzzahliger Wert.
+ Anzahl der **Abfragen** — Eine Abfrage muss mindestens so oft durchsucht werden, dass sie Ihren Benutzern vorgeschlagen werden kann. Diese Zahl ist ein ganzzahliger Wert.
Diese Einstellungen wirken sich darauf aus, wie Abfragen als beliebte Abfragen ausgewählt werden, um sie Ihren Benutzern vorzuschlagen. Wie Sie Ihre Einstellungen anpassen, hängt von Ihren spezifischen Bedürfnissen ab, zum Beispiel:
+ Wenn Ihre Benutzer in der Regel durchschnittlich einmal pro Monat suchen, können Sie die Anzahl der Tage im Zeitfenster für das Abfrageprotokoll auf 30 Tage festlegen. Mit dieser Einstellung erfassen Sie die meisten der letzten Abfragen Ihrer Benutzer, bevor sie im Zeitfenster veraltet sind.
+ Wenn nur eine geringe Anzahl Ihrer Abfragen Benutzerinformationen enthält und Sie keine Abfragen vorschlagen möchten, die auf einer kleinen Stichprobengröße basieren, können Sie Abfragen so einrichten, dass sie alle Benutzer einbeziehen.
+ Wenn Sie beliebte Abfragen so definieren, dass sie von mindestens 10 eindeutigen Benutzern und mindestens 100 Mal durchsucht werden, legen Sie die eindeutigen Benutzer auf 10 und die Anzahl der Abfragen auf 100 fest.
**Warnung**
Ihre Änderungen an den Einstellungen werden möglicherweise nicht sofort wirksam. Sie können die Änderungen an den Einstellungen mithilfe der [https://docs.aws.amazon.com/kendra/latest/APIReference/API_DescribeQuerySuggestionsConfig.html](https://docs.aws.amazon.com/kendra/latest/APIReference/API_DescribeQuerySuggestionsConfig.html)API verfolgen. Die Zeit, bis Ihre aktualisierten Einstellungen wirksam werden, hängt von den von Ihnen vorgenommenen Aktualisierungen und der Anzahl der Suchanfragen in Ihrem Index ab. Amazon Kendra aktualisiert die Vorschläge automatisch alle 24 Stunden, nachdem Sie eine Einstellung geändert oder eine [Sperrliste](https://docs.aws.amazon.com/kendra/latest/dg/query-suggestions.html#query-suggestions-blocklist) angewendet haben.
------
#### [ CLI ]
**Um Abfragevorschläge abzurufen**
```
aws kendra get-query-suggestions \
--index-id index-id \
--query-text "query-text" \
--suggestion-types '["QUERY"]' \
--max-suggestions-count 1 // If you want to limit the number of suggestions
```
**Um Abfragevorschläge zu aktualisieren**
Um beispielsweise das Zeitfenster für das Abfrageprotokoll und die Mindestanzahl der Suchvorgänge für eine Abfrage zu ändern, gehen Sie wie folgt vor:
```
aws kendra update-query-suggestions-config \
--index-id index-id \
--query-log-look-back-window-in-days 30 \
--minimum-query-count 100
```
------
#### [ Python ]
**Um Abfragevorschläge abzurufen**
```
import boto3
from botocore.exceptions import ClientError
kendra = boto3.client("kendra")
print("Get query suggestions.")
# Provide the index ID
index_id = "index-id"
# Provide the query text
query_text = "query"
# Provide the query suggestions type
query_suggestions_type = "QUERY"
# If you want to limit the number of suggestions
num_suggestions = 1
try:
query_suggestions_response = kendra.get_query_suggestions(
IndexId = index_id,
QueryText = query_text,
SuggestionTypes = query_suggestions_type,
MaxSuggestionsCount = num_suggestions
)
# Print out the suggestions you received
if ("Suggestions" in query_suggestions_response.keys()) {
for (suggestion: query_suggestions_response["Suggestions"]) {
print(suggestion["Value"]["Text"]["Text"]);
}
}
except ClientError as e:
print("%s" % e)
print("Program ends.")
```
**Um Abfragevorschläge zu aktualisieren**
Um beispielsweise das Zeitfenster für das Abfrageprotokoll und die Mindestanzahl der Suchvorgänge für eine Abfrage zu ändern, gehen Sie wie folgt vor:
```
import boto3
from botocore.exceptions import ClientError
import pprint
import time
kendra = boto3.client("kendra")
print("Updating query suggestions settings/configuration for an index.")
# Provide the index ID
index_id = "index-id"
# Configure the settings you want to update
minimum_query_count = 100
query_log_look_back_window_in_days = 30
try:
kendra.update_query_suggestions_config(
IndexId = index_id,
MinimumQueryCount = minimum_query_count,
QueryLogLookBackWindowInDays = query_log_look_back_window_in_days
)
print("Wait for Amazon Kendra to update the query suggestions.")
while True:
# Get query suggestions description of settings/configuration
query_sugg_config_response = kendra.describe_query_suggestions_config(
IndexId = index_id
)
# If status is not UPDATING, then quit
status = query_sugg_config_response["Status"]
print(" Updating query suggestions config. Status: " + status)
if status != "UPDATING":
break
time.sleep(60)
except ClientError as e:
print("%s" % e)
print("Program ends.")
```
------
### Vorschläge löschen und gleichzeitig den Abfrageverlauf beibehalten
**Anmerkung**
Die Funktionsunterstützung variiert je nach Indextyp und verwendeter Such-API. Informationen darüber, ob diese Funktion für den von Ihnen verwendeten Indextyp und die Such-API unterstützt wird, finden Sie unter [Indextypen](https://docs.aws.amazon.com/kendra/latest/dg/hiw-index-types.html).
Sie können Abfragevorschläge mithilfe der [https://docs.aws.amazon.com/kendra/latest/APIReference/API_DescribeQuerySuggestionsConfig.html](https://docs.aws.amazon.com/kendra/latest/APIReference/API_DescribeQuerySuggestionsConfig.html)API löschen. Durch das Löschen von Vorschlägen werden nur vorhandene Abfragevorschläge gelöscht, nicht die Abfragen im Abfrageverlauf. Wenn Sie Vorschläge löschen, Amazon Kendra lernt es neue Vorschläge auf der Grundlage neuer Abfragen, die dem Abfrageprotokoll seit dem Löschen der Vorschläge hinzugefügt wurden.
------
#### [ CLI ]
**Um Abfragevorschläge zu löschen**
```
aws kendra clear-query-suggestions \
--index-id index-id
```
------
#### [ Python ]
**Um Abfragevorschläge zu löschen**
```
import boto3
from botocore.exceptions import ClientError
kendra = boto3.client("kendra")
print("Clearing out query suggestions for an index.")
# Provide the index ID
index_id = "index-id"
try:
kendra.clear_query_suggestions(
IndexId = index_id
)
# Confirm last cleared date-time and that there are no suggestions
query_sugg_config_response = kendra.describe_query_suggestions_config(
IndexId = index_id
)
print("Query Suggestions last cleared at: " + str(query_sugg_config_response["LastClearTime"]));
print("Number of suggestions available from the time of clearing: " + str(query_sugg_config_response["TotalSuggestionsCount"]));
except ClientError as e:
print("%s" % e)
print("Program ends.")
```
------
### Keine Vorschläge verfügbar
Wenn Sie keine Vorschläge für eine Anfrage sehen, kann das einen der folgenden Gründe haben:
+ Ihr Index enthält nicht genügend Abfragen, aus denen Amazon Kendra Sie lernen könnten.
+ Ihre Einstellungen für Abfragevorschläge sind zu streng, was dazu führt, dass die meisten Abfragen aus den Vorschlägen herausgefiltert werden.
+ Sie haben vor Kurzem Vorschläge gelöscht und benötigen Amazon Kendra immer noch Zeit, bis sich neue Abfragen angesammelt haben, um neue Vorschläge zu sammeln.
Sie können Ihre aktuellen Einstellungen mithilfe der [https://docs.aws.amazon.com/kendra/latest/APIReference/API_DescribeQuerySuggestionsConfig.html](https://docs.aws.amazon.com/kendra/latest/APIReference/API_DescribeQuerySuggestionsConfig.html)API überprüfen.
## Fragen Sie Vorschläge mithilfe von Dokumentfeldern ab
**Topics**
+ [
### Einstellungen für die Auswahl von Feldern für Vorschläge
](#query-suggestions-doc-fields-settings)
+ [
### Benutzersteuerung in Dokumentfeldern
](#query-suggestions-doc-fields-user-control)
Sie können wählen, ob Sie anhand des Inhalts von Dokumentfeldern Abfragen vorschlagen möchten, die für Ihre Benutzer relevant sind. Anstatt den Abfrageverlauf zu verwenden, um andere beliebte relevante Abfragen vorzuschlagen, können Sie Informationen verwenden, die in einem Dokumentfeld enthalten sind und für die automatische Vervollständigung der Abfrage nützlich sind. Amazon Kendra sucht in Feldern, die auf eingestellt sind, nach `Suggestable` relevantem Inhalt, der eng mit der Anfrage Ihres Benutzers übereinstimmt. Schlägt Ihrem Benutzer diesen Inhalt dann Amazon Kendra vor, wenn er mit der Eingabe seiner Anfrage beginnt.
Wenn Sie beispielsweise das Titelfeld angeben, auf dem Vorschläge basieren sollen, und ein Benutzer beginnt, die Abfrage „Wie Amazon Ken... Amazon Kendra 'könnte der relevanteste Titel „Wie funktioniert“ vorgeschlagen werden, um die Suche automatisch zu vervollständigen. Der Nutzer sieht „So Amazon Kendra funktioniert“ direkt unter seiner Suchleiste und vervollständigt seine Suchabfrage automatisch. Der Benutzer wählt diesen Abfragevorschlag aus und das Dokument „So Amazon Kendra funktioniert“ wird in den Suchergebnissen angezeigt.
Sie können den Inhalt eines beliebigen Dokumentfeldes `String` und `StringList` -typs verwenden, um eine Abfrage vorzuschlagen, indem Sie das Feld `Suggestable` als Teil Ihrer Feldkonfiguration für Abfragevorschläge auf festlegen. Sie können auch eine [Blockliste](https://docs.aws.amazon.com/kendra/latest/dg/query-suggestions.html#query-suggestions-blocklist) verwenden, sodass vorgeschlagene Dokumentfelder, die bestimmte Wörter oder Ausdrücke enthalten, Ihren Benutzern nicht angezeigt werden. Sie können eine Blockliste verwenden. Die Sperrliste gilt unabhängig davon, ob Sie Abfragevorschläge so einrichten, dass sie den Abfrageverlauf oder die Dokumentfelder verwenden.
### Einstellungen für die Auswahl von Feldern für Vorschläge
Sie können die folgenden Einstellungen für die Auswahl von Dokumentfeldern für Vorschläge konfigurieren, indem Sie die [https://docs.aws.amazon.com/kendra/latest/APIReference/API_UpdateQuerySuggestionsConfig.html](https://docs.aws.amazon.com/kendra/latest/APIReference/API_UpdateQuerySuggestionsConfig.html)API verwenden [https://docs.aws.amazon.com/kendra/latest/APIReference/API_AttributeSuggestionsConfig.html](https://docs.aws.amazon.com/kendra/latest/APIReference/API_AttributeSuggestionsConfig.html)und aufrufen, um die Einstellungen auf Indexebene zu aktualisieren:
+ **Modus für Feld-/Attributvorschläge** — Abfragevorschläge, die Dokumentfelder verwenden, sind entweder oder. `ACTIVE` `INACTIVE` Amazon Kendra aktiviert standardmäßig Abfragevorschläge.
+ **Suggestible Felder/Attribute — Die Feldnamen oder Feldschlüssel, auf denen Vorschläge** basieren sollen. Diese Felder müssen als Teil der `TRUE` Feldkonfiguration auf für `Suggestable` gesetzt werden. Sie können die Feldkonfiguration auf Abfrageebene überschreiben und gleichzeitig die Konfiguration auf Indexebene beibehalten. Verwenden Sie die [GetQuerySuggestions](https://docs.aws.amazon.com/kendra/latest/APIReference/API_GetQuerySuggestions.html)API, um Änderungen `AttributeSuggestionConfig` auf Abfrageebene vorzunehmen. Diese Konfiguration auf Abfrageebene kann nützlich sein, um schnell mit der Verwendung verschiedener Dokumentfelder zu experimentieren, ohne die Konfiguration auf Indexebene aktualisieren zu müssen.
+ **Zusätzliche Felder/Attribute** — Die zusätzlichen Felder, die Sie in die Antwort auf einen Abfragevorschlag aufnehmen möchten. Diese Felder werden verwendet, um zusätzliche Informationen in der Antwort bereitzustellen, sie werden jedoch nicht als Grundlage für Vorschläge verwendet.
**Warnung**
Ihre Änderungen an den Einstellungen werden möglicherweise nicht sofort wirksam. Sie können die Änderungen an den Einstellungen mithilfe der [https://docs.aws.amazon.com/kendra/latest/APIReference/API_DescribeQuerySuggestionsConfig.html](https://docs.aws.amazon.com/kendra/latest/APIReference/API_DescribeQuerySuggestionsConfig.html)API verfolgen. Die Zeit, bis Ihre aktualisierten Einstellungen wirksam werden, hängt von den Aktualisierungen ab, die Sie vornehmen. Amazon Kendra aktualisiert die Vorschläge automatisch alle 24 Stunden, nachdem Sie eine Einstellung geändert oder eine [Sperrliste](https://docs.aws.amazon.com/kendra/latest/dg/query-suggestions.html#query-suggestions-blocklist) angewendet haben.
------
#### [ CLI ]
Um Abfragevorschläge abzurufen und die Konfiguration der Dokumentfelder auf Abfrageebene zu überschreiben, anstatt die Konfiguration auf Indexebene ändern zu müssen.
```
aws kendra get-query-suggestions \
--index-id index-id \
--query-text "query-text" \
--suggestion-types '["DOCUMENT_ATTRIBUTES"]' \
--attribute-suggestions-config '{"SuggestionAttributes":'["field/attribute key 1", "field/attribute key 2"]', "AdditionalResponseAttributes":'["response field/attribute key 1", "response field/attribute key 2"]'}' \
--max-suggestions-count 1 // If you want to limit the number of suggestions
```
**Um Abfragevorschläge zu aktualisieren**
Um beispielsweise die Konfiguration der Dokumentfelder auf Indexebene zu ändern:
```
aws kendra update-query-suggestions-config \
--index-id index-id \
--attribute-suggestions-config '{"SuggestableConfigList": '[{"SuggestableConfig": "_document_title", "Suggestable": true}]', "AttributeSuggestionsMode": "ACTIVE"}'
```
------
#### [ Python ]
Um Abfragevorschläge abzurufen und die Konfiguration der Dokumentfelder auf Abfrageebene zu überschreiben, anstatt die Konfiguration auf Indexebene ändern zu müssen.
```
import boto3
from botocore.exceptions import ClientError
kendra = boto3.client("kendra")
print("Get query suggestions.")
# Provide the index ID
index_id = "index-id"
# Provide the query text
query_text = "query"
# Provide the query suggestions type
query_suggestions_type = "DOCUMENT_ATTRIBUTES"
# Override fields/attributes configuration at query level
configuration = {"SuggestionAttributes":
'["field/attribute key 1", "field/attribute key 2"]',
"AdditionalResponseAttributes":
'["response field/attribute key 1", "response field/attribute key 2"]'
}
# If you want to limit the number of suggestions
num_suggestions = 1
try:
query_suggestions_response = kendra.get_query_suggestions(
IndexId = index_id,
QueryText = query_text,
SuggestionTypes = [query_suggestions_type],
AttributeSuggestionsConfig = configuration,
MaxSuggestionsCount = num_suggestions
)
# Print out the suggestions you received
if ("Suggestions" in query_suggestions_response.keys()) {
for (suggestion: query_suggestions_response["Suggestions"]) {
print(suggestion["Value"]["Text"]["Text"]);
}
}
except ClientError as e:
print("%s" % e)
print("Program ends.")
```
**Um Abfragevorschläge zu aktualisieren**
Um beispielsweise die Konfiguration der Dokumentfelder auf Indexebene zu ändern:
```
import boto3
from botocore.exceptions import ClientError
import pprint
import time
kendra = boto3.client("kendra")
print("Updating query suggestions settings/configuration for an index.")
# Provide the index ID
index_id = "index-id"
# Configure the settings you want to update at the index level
configuration = {"SuggestableConfigList":
'[{"SuggestableConfig": "_document_title", "Suggestable": true}]',
"AttributeSuggestionsMode": "ACTIVE"
}
try:
kendra.update_query_suggestions_config(
IndexId = index_id,
AttributeSuggestionsConfig = configuration
)
print("Wait for Amazon Kendra to update the query suggestions.")
while True:
# Get query suggestions description of settings/configuration
query_sugg_config_response = kendra.describe_query_suggestions_config(
IndexId = index_id
)
# If status is not UPDATING, then quit
status = query_sugg_config_response["Status"]
print(" Updating query suggestions config. Status: " + status)
if status != "UPDATING":
break
time.sleep(60)
except ClientError as e:
print("%s" % e)
print("Program ends.")
```
------
### Benutzersteuerung in Dokumentfeldern
Sie können die Benutzerkontextfilterung auf die Dokumentfelder anwenden, auf denen Sie Abfragevorschläge basieren möchten. Dadurch werden Dokumentfeldinformationen basierend auf dem Benutzer- oder Gruppenzugriff auf Dokumente gefiltert. Beispielsweise durchsucht ein Praktikant das Unternehmensportal und hat keinen Zugriff auf ein streng geheimes Unternehmensdokument. Aus diesem Grund werden dem Praktikanten keine Suchanfragen angezeigt, die auf dem Titel des streng geheimen Dokuments oder einem anderen Eingabefeld basieren.
Sie können Ihre Dokumente mit einer Zugriffskontrollliste (ACL) indexieren, in der festgelegt wird, welchen Benutzern und Gruppen Zugriff auf welche Dokumente gewährt wird. Anschließend können Sie die Benutzerkontextfilterung auf die Felder Ihrer Dokumente anwenden, um Abfragevorschläge zu erhalten. Die Benutzerkontextfilterung, die derzeit für Ihren Index festgelegt ist, ist dieselbe Benutzerkontextfilterung, die auf Ihre Konfiguration der Dokumentfelder für Abfragevorschläge angewendet wurde. Die Benutzerkontextfilterung ist Teil der Konfiguration Ihrer Dokumentfelder. Sie verwenden den [https://docs.aws.amazon.com/kendra/latest/APIReference/API_AttributeSuggestionsConfig.html](https://docs.aws.amazon.com/kendra/latest/APIReference/API_AttributeSuggestionsConfig.html)und -Aufruf [https://docs.aws.amazon.com/kendra/latest/APIReference/API_GetQuerySuggestions.html](https://docs.aws.amazon.com/kendra/latest/APIReference/API_GetQuerySuggestions.html).
## Sperren Sie bestimmte Abfragen oder dokumentieren Sie Feldinhalte aus Vorschlägen
Eine *Blockliste* Amazon Kendra verhindert, dass Ihren Benutzern bestimmte Abfragen vorgeschlagen werden. Eine Blockliste ist eine Liste von Wörtern oder Ausdrücken, die Sie von Abfragevorschlägen ausschließen möchten. Amazon Kendra schließt Abfragen aus, die eine exakte Übereinstimmung mit den Wörtern oder Ausdrücken in der Blockliste enthalten.
Sie können eine Sperrliste verwenden, um sich vor anstößigen Wörtern oder Ausdrücken zu schützen, die häufig in Ihrem Abfrageverlauf oder in Dokumentfeldern vorkommen und die als Vorschläge ausgewählt werden Amazon Kendra könnten. Eine Sperrliste kann auch Amazon Kendra verhindern, dass Abfragen vorgeschlagen werden, die Informationen enthalten, die noch nicht veröffentlicht oder angekündigt werden können. Beispielsweise fragen Ihre Benutzer häufig nach einer bevorstehenden Veröffentlichung eines potenziellen neuen Produkts. Sie möchten das Produkt jedoch nicht vorschlagen, da Sie noch nicht bereit sind, es zu veröffentlichen. Sie können Anfragen, die den Produktnamen und Produktinformationen enthalten, aus Vorschlägen ausschließen.
Mithilfe der API können Sie eine Sperrliste für Abfragen erstellen. [https://docs.aws.amazon.com/kendra/latest/APIReference/API_CreateQuerySuggestionsBlockList.html](https://docs.aws.amazon.com/kendra/latest/APIReference/API_CreateQuerySuggestionsBlockList.html) Sie fügen jedes Blockwort oder jede Wortgruppe in eine separate Zeile in einer Textdatei ein. Anschließend laden Sie die Textdatei in Ihren Amazon S3 S3-Bucket hoch und geben den Pfad oder Speicherort der Datei an Amazon S3. Amazon Kendra unterstützt derzeit nur die Erstellung einer Blockliste.
Sie können die Textdatei mit Ihren blockierten Wörtern und Ausdrücken in Ihrem Amazon S3 Bucket ersetzen. Verwenden Sie die [https://docs.aws.amazon.com/kendra/latest/APIReference/API_UpdateQuerySuggestionsBlockList.html](https://docs.aws.amazon.com/kendra/latest/APIReference/API_UpdateQuerySuggestionsBlockList.html)API Amazon Kendra, um die Blockliste zu aktualisieren.
Verwenden Sie die [https://docs.aws.amazon.com/kendra/latest/APIReference/API_DescribeQuerySuggestionsBlockList.html](https://docs.aws.amazon.com/kendra/latest/APIReference/API_DescribeQuerySuggestionsBlockList.html)API, um den Status Ihrer Blockliste abzurufen. `DescribeQuerySuggestionsBlockList`kann Ihnen auch andere nützliche Informationen zur Verfügung stellen, z. B. die folgenden:
+ Wann wurde Ihre Sperrliste zuletzt aktualisiert
+ Wie viele Wörter oder Ausdrücke befinden sich in Ihrer aktuellen Blockliste
+ Hilfreiche Fehlermeldungen beim Erstellen einer Blockliste
Sie können die [https://docs.aws.amazon.com/kendra/latest/APIReference/API_ListQuerySuggestionsBlockLists.html](https://docs.aws.amazon.com/kendra/latest/APIReference/API_ListQuerySuggestionsBlockLists.html)API auch verwenden, um eine Liste mit Zusammenfassungen von Blocklisten für einen Index abzurufen.
Verwenden Sie die [DeleteQuerySuggestionsBlockList](https://docs.aws.amazon.com/kendra/latest/APIReference/API_DeleteQuerySuggestionsBlockList.html)API, um Ihre Blockliste zu löschen.
Ihre Aktualisierungen der Blockliste werden möglicherweise nicht sofort wirksam. Sie können Aktualisierungen mithilfe der `DescribeQuerySuggestionsBlockList` API verfolgen.
------
#### [ CLI ]
**Um eine Blockliste zu erstellen**
```
aws kendra create-query-suggestions-block-list \
--index-id index-id \
--name "block-list-name" \
--description "block-list-description" \
--source-s3-path "Bucket=bucket-name,Key=query-suggestions/block_list.txt" \
--role-arn role-arn
```
**Um eine Blockliste zu aktualisieren**
```
aws kendra update-query-suggestions-block-list \
--index-id index-id \
--name "new-block-list-name" \
--description "new-block-list-description" \
--source-s3-path "Bucket=bucket-name,Key=query-suggestions/new_block_list.txt" \
--role-arn role-arn
```
**Um eine Blockliste zu löschen**
```
aws kendra delete-query-suggestions-block-list \
--index-id index-id \
--id block-list-id
```
------
#### [ Python ]
**Um eine Blockliste zu erstellen**
```
import boto3
from botocore.exceptions import ClientError
import pprint
import time
kendra = boto3.client("kendra")
print("Create a query suggestions block list.")
# Provide a name for the block list
block_list_name = "block-list-name"
# Provide an optional description for the block list
block_list_description = "block-list-description"
# Provide the IAM role ARN required for query suggestions block lists
block_list_role_arn = "role-arn"
# Provide the index ID
index_id = "index-id"
s3_bucket_name = "bucket-name"
s3_key = "query-suggestions/block_list.txt"
source_s3_path = {
'Bucket': s3_bucket_name,
'Key': s3_key
}
try:
block_list_response = kendra.create_query_suggestions_block_list(
Description = block_list_description,
Name = block_list_name,
RoleArn = block_list_role_arn,
IndexId = index_id,
SourceS3Path = source_s3_path
)
print(block_list_response)
block_list_id = block_list_response["Id"]
print("Wait for Amazon Kendra to create the block list.")
while True:
# Get block list description
block_list_description = kendra.describe_query_suggestions_block_list(
Id = block_list_id,
IndexId = index_id
)
# If status is not CREATING, then quit
status = block_list_description["Status"]
print("Creating block list. Status: " + status)
if status != "CREATING":
break
time.sleep(60)
except ClientError as e:
print("%s" % e)
print("Program ends.")
```
**Um eine Blockliste zu aktualisieren**
```
import boto3
from botocore.exceptions import ClientError
import pprint
import time
kendra = boto3.client("kendra")
print("Update a block list for query suggestions.")
# Provide the block list name you want to update
block_list_name = "new-block-list-name"
# Provide the block list description you want to update
block_list_description = "new-block-list-description"
# Provide the IAM role ARN required for query suggestions block lists
block_list_role_arn = "role-arn"
# Provide the block list ID
block_list_id = "block-list-id"
# Provide the index ID
index_id = "index-id"
s3_bucket_name = "bucket-name"
s3_key = "query-suggestions/new_block_list.txt"
source_s3_path = {
'Bucket': s3_bucket_name,
'Key': s3_key
}
try:
kendra.update_query_suggestions_block_list(
Id = block_list_id,
IndexId = index_id,
Description = block_list_description,
Name = block_list_name,
RoleArn = block_list_role_arn,
SourceS3Path = source_s3_path
)
print("Wait for Amazon Kendra to update the block list.")
while True:
# Get block list description
block_list_description = kendra.describe_query_suggestions_block_list(
Id = block_list_id,
IndexId = index_id
)
# If status is not UPDATING, then the update has finished
status = block_list_description["Status"]
print("Updating block list. Status: " + status)
if status != "UPDATING":
break
time.sleep(60)
except ClientError as e:
print("%s" % e)
print("Program ends.")
```
**Um eine Blockliste zu löschen**
```
import boto3
from botocore.exceptions import ClientError
kendra = boto3.client("kendra")
print("Delete a block list for query suggestions.")
# provide the block list ID
query_suggestions_block_list_id = "query-suggestions-block-list-id"
# Provide the index ID
index_id = "index-id"
try:
kendra.delete_query_suggestions_block_list(
Id = query_suggestions_block_list_id,
IndexId = index_id
)
except ClientError as e:
print("%s" % e)
print("Program ends.")
```
------
# Rechtschreibprüfung abfragen
**Anmerkung**
Die Funktionsunterstützung variiert je nach Indextyp und verwendeter Such-API. Informationen darüber, ob diese Funktion für den von Ihnen verwendeten Indextyp und die Such-API unterstützt wird, finden Sie unter [Indextypen](https://docs.aws.amazon.com/kendra/latest/dg/hiw-index-types.html).
Amazon Kendra Die *Rechtschreibprüfung* schlägt Rechtschreibkorrekturen für eine Abfrage vor. Auf diese Weise können Sie das Vorkommen von null Suchergebnissen auf ein Minimum reduzieren und relevante Ergebnisse zurückgeben. Ihre Benutzer erhalten möglicherweise [keine Suchergebnisse bei](https://docs.aws.amazon.com/kendra/latest/dg/search-analytics.html#search-analytics-metrics) falsch geschriebenen Abfragen ohne übereinstimmende Ergebnisse oder ohne zurückgegebene Dokumente. Oder Ihre Benutzer erhalten möglicherweise [irrelevante Suchergebnisse aufgrund falsch geschriebener](https://docs.aws.amazon.com/kendra/latest/dg/search-analytics.html#search-analytics-metrics) Abfragen.
Die Rechtschreibprüfung ist so konzipiert, dass sie anhand der Wörter, die in Ihren indizierten Dokumenten vorkommen, Korrekturen für falsch geschriebene Wörter vorschlägt und darauf basiert, wie genau ein korrigiertes Wort mit einem falsch geschriebenen Wort übereinstimmt. Wenn beispielsweise das Wort „Kontoauszüge“ in Ihren indexierten Dokumenten vorkommt, könnte dies dem falsch geschriebenen Wort „Kontoauszüge“ in der Abfrage „Jahresabschlüsse“ sehr nahe kommen.
Die Rechtschreibprüfung gibt die beabsichtigten oder korrigierten Wörter zurück, die falsch geschriebene Wörter im ursprünglichen Abfragetext ersetzen. Zum Beispiel könnte „Kendre-Suche bereitstellen“ „Kendra-Suche bereitstellen“ zurückgeben. Sie können auch Offset-Positionen verwenden, die in der API bereitgestellt werden, um die zurückgegebenen korrigierten Wörter in einer Abfrage in Ihrer Frontend-Anwendung hervorzuheben oder kursiv zu formatieren. In der Konsole sind die korrigierten Wörter standardmäßig hervorgehoben oder kursiv gedruckt. Zum Beispiel „*Bereitstellung* der *Kendra-Suche*“.
Bei unternehmensspezifischen oder speziellen Begriffen, die in Ihren indizierten Dokumenten vorkommen, interpretiert Spell Checker diese Begriffe nicht als Rechtschreibfehler in der Abfrage. Beispielsweise wird „Amazon Macie“ nicht in „Amazon Mace“ geändert.
Wörter mit Bindestrich, wie z. B. „Jahresende“, behandelt die Rechtschreibprüfung als einzelne Wörter und schlägt Korrekturen für diese Wörter vor. Die vorgeschlagene Korrektur für „Jahresende“ könnte beispielsweise „Jahresende“ lauten.
Für Antworttypen `DOCUMENT` und `QUESTION_ANSWER` Abfragen schlägt die Rechtschreibprüfung anhand von Wörtern im Hauptteil des Dokuments Korrekturen für falsch geschriebene Wörter vor. Der Hauptteil des Dokuments ist zuverlässiger als der Titel, wenn es darum geht, Korrekturen vorzuschlagen, die den falsch geschriebenen Wörtern sehr nahe kommen. Bei Antworten auf `ANSWER` Abfragen schlägt die Rechtschreibprüfung Korrekturen vor, die auf Wörtern im Standarddokument für Fragen und Antworten in Ihrem Index basieren.
Sie können die Rechtschreibprüfung mithilfe des [SpellCorrectionConfiguration](https://docs.aws.amazon.com/kendra/latest/APIReference/API_SpellCorrectionConfiguration.html)Objekts aktivieren. Sie haben auf eingestellt`IncludeQuerySpellCheckSuggestions`. `TRUE` Die Rechtschreibprüfung ist in der Konsole standardmäßig aktiviert. Sie ist standardmäßig in die Konsole integriert.
Die Rechtschreibprüfung kann auch Rechtschreibkorrekturen für Abfragen in mehreren Sprachen vorschlagen, nicht nur in Englisch. Eine Liste der Sprachen, die von Spell Checker unterstützt werden, finden Sie unter [Amazon Kendra Unterstützte](https://docs.aws.amazon.com/kendra/latest/dg/in-adding-languages.html) Sprachen.
## Verwenden der Abfrage-Rechtschreibprüfung mit Standardgrenzwerten
Die Rechtschreibprüfung ist mit bestimmten Standardeinstellungen oder Grenzwerten konzipiert. Im Folgenden finden Sie eine Liste der aktuellen Grenzwerte, die gelten, wenn Sie Vorschläge zur Rechtschreibkorrektur aktivieren.
+ Vorgeschlagene Rechtschreibkorrekturen können nicht für Wörter zurückgegeben werden, die weniger als drei Zeichen oder mehr als 30 Zeichen lang sind. Wenn Sie mehr als 30 Zeichen oder weniger als drei Zeichen zulassen möchten, wenden Sie sich an den [Support](https://aws.amazon.com/contact-us/).
+ Vorgeschlagene Rechtschreibkorrekturen können Vorschläge, die auf der Benutzerzugriffskontrolle oder Ihrer Zugriffskontrollliste für die [Benutzerkontextfilterung](https://docs.aws.amazon.com/kendra/latest/dg/user-context-filter.html) basieren, nicht einschränken. Rechtschreibkorrekturen basieren auf allen Wörtern in Ihren indizierten Dokumenten, unabhängig davon, ob die Wörter auf bestimmte Benutzer beschränkt sind oder nicht. Wenn Sie vermeiden möchten, dass bestimmte Wörter in den vorgeschlagenen Rechtschreibkorrekturen für Abfragen vorkommen, sollten Sie diese Option nicht aktivieren`SpellCorrectionConfiguration`.
+ Vorgeschlagene Rechtschreibkorrekturen können für Wörter, die Zahlen enthalten, nicht zurückgegeben werden. Zum Beispiel „how 2 not br8k ubun2“.
+ Vorgeschlagene Rechtschreibkorrekturen dürfen keine Wörter verwenden, die nicht in Ihren indizierten Dokumenten vorkommen.
+ Bei den vorgeschlagenen Rechtschreibkorrekturen dürfen keine Wörter verwendet werden, die in Ihren indexierten Dokumenten weniger als 0,01 Prozent vorkommen. Um den Schwellenwert von 0,01% zu ändern, wenden Sie sich an den [Support](https://aws.amazon.com/contact-us/).
# Filterung und Facettensuche
**Anmerkung**
Die Funktionsunterstützung variiert je nach Indextyp und verwendeter Such-API. Informationen darüber, ob diese Funktion für den von Ihnen verwendeten Indextyp und die Such-API unterstützt wird, finden Sie unter [Indextypen](https://docs.aws.amazon.com/kendra/latest/dg/hiw-index-types.html).
Sie können die Suchergebnisse oder die Antwort der [Abfrage-API](https://docs.aws.amazon.com/kendra/latest/APIReference/API_Query.html) verbessern, indem Sie Filter verwenden. Filter beschränken die Anzahl der Dokumente in der Antwort auf Dokumente, die direkt auf die Abfrage zutreffen. Um facettierte Suchvorschläge zu erstellen, verwenden Sie die boolesche Logik, um bestimmte Dokumentattribute oder Dokumente, die bestimmten Kriterien nicht entsprechen, aus der Antwort herauszufiltern. Sie können Facetten mithilfe des `Facets` Parameters in der API angeben. `Query`
[Verwenden Sie AMAZON, um nach Dokumenten zu suchen, die Sie mit Amazon Kendra for Amazon Lex indexiert haben. KendraSearchIntent](https://docs.aws.amazon.com/lexv2/latest/APIReference/API_KendraConfiguration.html). Ein Beispiel für die Konfiguration Amazon Kendra mit Amazon Lex finden Sie unter [Einen FAQ-Bot für einen Amazon Kendra Index](https://docs.aws.amazon.com/lexv2/latest/dg/faq-bot-kendra-search.html) erstellen. Sie können auch einen Filter für die Antwort bereitstellen, indem Sie [AttributeFilter](https://docs.aws.amazon.com/kendra/latest/APIReference/API_AttributeFilter.html) Dies ist der Abfragefilter in JSON bei der Konfiguration`AMAZON.KendraSearchIntent`. Um bei der Konfiguration einer Suchabsicht in der Konsole einen Attributfilter bereitzustellen, rufen Sie den Intent-Editor auf und wählen Sie Amazon Kendra Query aus, um einen Abfragefilter in JSON bereitzustellen. Weitere Informationen zu `AMAZON.KendraSearchIntent` finden Sie im [Amazon Lex Dokumentationsleitfaden](https://docs.aws.amazon.com/lexv2/latest/dg/built-in-intent-kendra-search.html).
## Facets
Facetten sind bereichsbezogene Ansichten einer Reihe von Suchergebnissen. Sie können beispielsweise Suchergebnisse für Städte auf der ganzen Welt bereitstellen, in denen Dokumente nach einer bestimmten Stadt gefiltert werden, der sie zugeordnet sind. Oder Sie können Facetten erstellen, um Ergebnisse eines bestimmten Autors anzuzeigen.
Sie können ein Dokumentattribut oder ein Metadatenfeld, das einem Dokument zugeordnet ist, als Facette verwenden, sodass Ihre Benutzer innerhalb dieser Facette nach Kategorien oder Werten suchen können. Sie können auch verschachtelte Facetten in den Suchergebnissen anzeigen, sodass Ihre Benutzer nicht nur nach einer Kategorie oder einem Feld, sondern auch nach einer Unterkategorie oder einem Unterfeld suchen können.
Das folgende Beispiel zeigt, wie Facetteninformationen für das benutzerdefinierte Attribut „Stadt“ abgerufen werden.
```
response=kendra.query(
QueryText = query,
IndexId = index,
Facets = [
{
"DocumentAttributeKey" : "City"
}
]
)
```
Sie können verschachtelte Facetten verwenden, um die Suche weiter einzugrenzen. Beispielsweise enthält das Dokumentattribut oder die Facette „Stadt“ einen Wert namens „Seattle“. Darüber hinaus enthält das Dokumentattribut oder die Facette "CityRegion" die Werte „North“ und „South“ für Dokumente, die „Seattle“ zugewiesen sind. Sie können verschachtelte Facetten mit ihrer Anzahl in den Suchergebnissen anzeigen, sodass Dokumente nicht nur nach Stadt, sondern auch nach einer Region innerhalb einer Stadt durchsucht werden können.
Beachten Sie, dass verschachtelte Facetten die Abfragelatenz beeinflussen können. Als allgemeine Regel gilt: Je mehr verschachtelte Facetten Sie verwenden, desto größer ist die potenzielle Auswirkung auf die Latenz. Andere Faktoren, die sich auf die Latenz auswirken, sind die durchschnittliche Größe der indizierten Dokumente, die Größe Ihres Indexes, hochkomplexe Abfragen und die Gesamtauslastung Ihres Index. Amazon Kendra
Das folgende Beispiel zeigt, wie Facetteninformationen für das benutzerdefinierte Attribut "CityRegion" als verschachtelte Facette innerhalb von „City“ abgerufen werden.
```
response=kendra.query(
QueryText = query,
IndexId = index,
Facets = [
{
"DocumentAttributeKey" : "City",
"Facets": [
{
"DocumentAttributeKey" : "CityRegion"
}
]
}
]
)
```
Facetteninformationen, wie z. B. die Anzahl der Dokumente, werden im Antwort-Array zurückgegeben. `FacetResults` Sie verwenden den Inhalt, um facettierte Suchvorschläge in Ihrer Anwendung anzuzeigen. Wenn das Dokumentattribut „Stadt“ beispielsweise die Stadt enthält, für die eine Suche gelten könnte, verwenden Sie diese Informationen, um eine Liste von Suchanfragen nach Städten anzuzeigen. Benutzer können eine Stadt auswählen, um ihre Suchergebnisse zu filtern. Um die facettierte Suche durchzuführen, rufen Sie die [Query](https://docs.aws.amazon.com/kendra/latest/APIReference/API_Query.html) API auf und verwenden Sie das gewählte Dokumentattribut, um die Ergebnisse zu filtern.
Sie können bis zu 10 Facettenwerte pro Facette für eine Abfrage und nur eine verschachtelte Facette innerhalb einer Facette anzeigen. Wenn Sie diese Limits erhöhen möchten, wenden Sie sich an den [Support](https://aws.amazon.com/contact-us/). Wenn Sie die Anzahl der Facettenwerte pro Facette auf weniger als 10 beschränken möchten, können Sie dies im `Facet` Objekt angeben.
Die folgende JSON-Beispielantwort zeigt Facetten, die auf das Dokumentattribut „City“ beschränkt sind. Die Antwort beinhaltet die Anzahl der Dokumente für den Facettenwert.
```
{
'FacetResults': [
{
'DocumentAttributeKey': 'City',
'DocumentAttributeValueCountPairs': [
{
'Count': 3,
'DocumentAttributeValue': {
'StringValue': 'Dubai'
}
},
{
'Count': 3,
'DocumentAttributeValue': {
'StringValue': 'Seattle'
}
},
{
'Count': 1,
'DocumentAttributeValue': {
'StringValue': 'Paris'
}
}
]
}
]
```
Sie können auch Facetteninformationen für eine verschachtelte Facette anzeigen, z. B. eine Region innerhalb einer Stadt, um die Suchergebnisse weiter zu filtern.
Die folgende JSON-Beispielantwort zeigt Facetten, die auf das Dokumentattribut "CityRegion" beschränkt sind, als verschachtelte Facette innerhalb von „City“. Die Antwort beinhaltet die Anzahl der Dokumente für die verschachtelten Facettenwerte.
```
{
'FacetResults': [
{
'DocumentAttributeKey': 'City',
'DocumentAttributeValueCountPairs': [
{
'Count': 3,
'DocumentAttributeValue': {
'StringValue': 'Dubai'
},
'FacetResults': [
{
'DocumentAttributeKey': 'CityRegion',
'DocumentAttributeValueCountPairs': [
{
'Count': 2,
'DocumentAttributeValue': {
'StringValue': 'Bur Dubai'
}
},
{
'Count': 1,
'DocumentAttributeValue': {
'StringValue': 'Deira'
}
}
]
}
]
},
{
'Count': 3,
'DocumentAttributeValue': {
'StringValue': 'Seattle'
},
'FacetResults': [
{
'DocumentAttributeKey': 'CityRegion',
'DocumentAttributeValueCountPairs': [
{
'Count': 1,
'DocumentAttributeValue': {
'StringValue': 'North'
}
},
{
'Count': 2,
'DocumentAttributeValue': {
'StringValue': 'South'
}
}
]
}
]
},
{
'Count': 1,
'DocumentAttributeValue': {
'StringValue': 'Paris'
},
'FacetResults': [
{
'DocumentAttributeKey': 'CityRegion',
'DocumentAttributeValueCountPairs': [
{
'Count': 1,
'DocumentAttributeValue': {
'StringValue': 'City center'
}
}
]
}
]
}
}
]
}
```
Wenn Sie ein Zeichenkettenlistenfeld verwenden, um Facetten zu erstellen, basieren die zurückgegebenen Facettenergebnisse auf dem Inhalt der Zeichenfolgenliste. Wenn Sie beispielsweise ein Zeichenkettenlistenfeld haben, das zwei Elemente enthält, eines mit der Liste „Dackel“, „Wursthund“ und eines mit dem Wert „Husky“, erhalten Sie drei Facetten. `FacetResults`
Weitere Informationen finden Sie unter [Antworten und Antworttypen abfragen](query-responses-types.md).
## Verwenden von Dokumentattributen zum Filtern von Suchergebnissen
`Query`Gibt standardmäßig alle Suchergebnisse zurück. Um Antworten zu filtern, können Sie logische Operationen an den Dokumentattributen ausführen. Wenn Sie beispielsweise nur Dokumente für eine bestimmte Stadt benötigen, können Sie nach den benutzerdefinierten Dokumentattributen „Stadt“ und „Bundesland“ filtern. Verwenden Sie [AttributeFilter](https://docs.aws.amazon.com/kendra/latest/APIReference/API_AttributeFilter.html), um eine boolesche Operation für die von Ihnen angegebenen Filter zu erstellen.
Die meisten Attribute können verwendet werden, um Antworten für alle [Antworttypen](https://docs.aws.amazon.com/kendra/latest/dg/query-responses-types.html) zu filtern. Das `_excerpt_page_number` Attribut gilt jedoch nur für `ANSWER` Antworttypen, wenn Antworten gefiltert werden.
Das folgende Beispiel zeigt, wie eine logische UND-Operation ausgeführt wird, indem nach einer bestimmten Stadt, *Seattle*, und einem Bundesstaat, *Washington*, gefiltert wird.
```
response=kendra.query(
QueryText = query,
IndexId = index,
AttributeFilter = {'AndAllFilters':
[
{"EqualsTo": {"Key": "City","Value": {"StringValue": "Seattle"}}},
{"EqualsTo": {"Key": "State","Value": {"StringValue": "Washington"}}}
]
}
)
```
Das folgende Beispiel zeigt, wie eine logische OR-Operation ausgeführt wird, wenn einer der `SourceURI` Schlüssel `Fileformat``Author`, oder den angegebenen Werten entspricht.
```
response=kendra.query(
QueryText = query,
IndexId = index,
AttributeFilter = {'OrAllFilters':
[
{"EqualsTo": {"Key": "Fileformat","Value": {"StringValue": "AUTO_DETECT"}}},
{"EqualsTo": {"Key": "Author","Value": {"StringValue": "Ana Carolina"}}},
{"EqualsTo": {"Key": "SourceURI","Value": {"StringValue": "https://aws.amazonaws.com/234234242342"}}}
]
}
)
```
Verwenden Sie für `StringList` Felder die `ContainsAll` Attributfilter `ContainsAny` oder, um Dokumente mit der angegebenen Zeichenfolge zurückzugeben. Das folgende Beispiel zeigt, wie alle Dokumente zurückgegeben werden, deren `Locations` benutzerdefiniertes Attribut die Werte „Seattle“ oder „Portland“ enthält.
```
response=kendra.query(
QueryText = query,
IndexId = index,
AttributeFilter = {
"ContainsAny": { "Key": "Locations", "Value": { "StringListValue": [ "Seattle", "Portland"] }}
}
)
```
## Filterung der Attribute der einzelnen Dokumente in den Suchergebnissen
Amazon Kendra gibt Dokumentattribute für jedes Dokument in den Suchergebnissen zurück. Sie können bestimmte Dokumentattribute filtern, die Sie als Teil der Suchergebnisse in die Antwort aufnehmen möchten. Standardmäßig werden alle einem Dokument zugewiesenen Dokumentattribute in der Antwort zurückgegeben.
Im folgenden Beispiel sind nur die `_author` Dokumentattribute `_source_uri` und in der Antwort für ein Dokument enthalten.
```
response=kendra.query(
QueryText = query,
IndexId = index,
RequestedDocumentAttributes = ["_source_uri", "_author"]
)
```
# Filtern nach Benutzerkontext
**Anmerkung**
Die Funktionsunterstützung variiert je nach Indextyp und verwendeter Such-API. Informationen darüber, ob diese Funktion für den von Ihnen verwendeten Indextyp und die Such-API unterstützt wird, finden Sie unter [Indextypen](https://docs.aws.amazon.com/kendra/latest/dg/hiw-index-types.html).
Sie können die Suchergebnisse eines Benutzers nach dem Zugriff des Benutzers oder seiner Gruppe auf Dokumente filtern. Sie können ein Benutzertoken, eine Benutzer-ID oder ein Benutzerattribut verwenden, um Dokumente zu filtern.
Die Benutzerkontextfilterung ist eine Art personalisierte Suche mit dem Vorteil, den Zugriff auf Dokumente zu kontrollieren. Beispielsweise sollten nicht alle Teams, die das Unternehmensportal nach Informationen durchsuchen, auf streng geheime Unternehmensdokumente zugreifen, und diese Dokumente sind auch nicht für alle Benutzer relevant. Nur bestimmte Benutzer oder Gruppen von Teams, denen Zugriff auf streng geheime Dokumente gewährt wurde, sollten diese Dokumente in ihren Suchergebnissen sehen.
Wenn ein Dokument indexiert wird Amazon Kendra, wird für die meisten Dokumente eine entsprechende Zugriffskontrollliste (ACL) aufgenommen. Die ACL gibt an, welche Benutzer- und Gruppennamen der Zugriff auf das Dokument erlaubt oder verweigert wird. Dokumente ohne ACL sind öffentliche Dokumente.
Amazon Kendra kann für die meisten Datenquellen die Benutzer- oder Gruppeninformationen extrahieren, die jedem Dokument zugeordnet sind. Ein Dokument in Quip kann beispielsweise eine Liste mit ausgewählten Benutzern enthalten, denen Zugriff auf das Dokument gewährt wird. Wenn Sie einen S3-Bucket als Datenquelle verwenden, stellen Sie eine [JSON-Datei](https://docs.aws.amazon.com/kendra/latest/dg/s3-acl.html) für Ihre ACL bereit und fügen den S3-Pfad zu dieser Datei als Teil der Datenquellenkonfiguration hinzu. Wenn Sie Dokumente direkt zu einem Index hinzufügen, geben Sie die ACL im [Principal-Objekt](https://docs.aws.amazon.com/kendra/latest/APIReference/API_Principal.html) als Teil des Dokumentobjekts in der [BatchPutDocument](https://docs.aws.amazon.com/kendra/latest/APIReference/API_BatchPutDocument.html)API an.
Wenn Sie einen Amazon Kendra Enterprise- oder Developer Edition-Index verwenden, können Sie die [CreateAccessControlConfiguration](https://docs.aws.amazon.com/kendra/latest/APIReference/API_CreateAccessControlConfiguration.html)API verwenden, um Ihre bestehende Zugriffskontrolle auf Dokumentenebene neu zu konfigurieren, ohne alle Ihre Dokumente erneut zu indizieren. Ihr Index enthält beispielsweise streng geheime Unternehmensdokumente, auf die nur bestimmte Mitarbeiter oder Benutzer zugreifen sollten. Einer dieser Benutzer verlässt das Unternehmen oder wechselt zu einem Team, das für den Zugriff auf streng geheime Dokumente gesperrt werden sollte. Der Benutzer hat weiterhin Zugriff auf streng geheime Dokumente, da er Zugriff hatte, als Ihre Dokumente zuvor indexiert wurden. Sie können eine spezielle Konfiguration der Zugriffskontrolle für den Benutzer erstellen, dem der Zugriff verweigert wurde. Sie können die Konfiguration der Zugriffskontrolle später aktualisieren, um den Zugriff zu ermöglichen, falls der Benutzer in das Unternehmen zurückkehrt und wieder dem „streng geheimen“ Team beitritt. Sie können die Zugriffskontrolle für Ihre Dokumente neu konfigurieren, wenn sich die Umstände ändern.
Um Ihre Zugriffskontrollkonfiguration auf bestimmte Dokumente anzuwenden, rufen Sie die [BatchPutDocument](https://docs.aws.amazon.com/kendra/latest/APIReference/API_BatchPutDocument.html)API mit dem im [Dokument `AccessControlConfigurationId`](https://docs.aws.amazon.com/kendra/latest/APIReference/API_Document.html) enthaltenen Objekt auf. Wenn Sie einen S3-Bucket als Datenquelle verwenden, aktualisieren Sie den `.metadata.json` mit der `AccessControlConfigurationId` und synchronisieren Ihre Datenquelle. Amazon Kendra unterstützt derzeit nur die Konfiguration der Zugriffskontrolle für S3-Datenquellen und Dokumente, die mithilfe der `BatchPutDocument` API indexiert wurden.
## Filterung nach Benutzertoken
**Wichtig**
Amazon Kendra GenAI Enterprise Edition-Indizes unterstützen keine tokenbasierte Benutzerzugriffskontrolle.
Wenn Sie einen Index abfragen, können Sie ein Benutzertoken verwenden, um Suchergebnisse nach dem Benutzer- oder Gruppenzugriff auf Dokumente zu filtern. Wenn Sie eine Abfrage ausgeben, wird das Token Amazon Kendra extrahiert und validiert, die Benutzer- und Gruppeninformationen abgerufen und überprüft und die Abfrage ausgeführt. Alle Dokumente, auf die der Benutzer Zugriff hat, einschließlich öffentlicher Dokumente, werden zurückgegeben. Weitere Informationen finden Sie unter [Tokenbasierte Benutzerzugriffskontrolle](https://docs.aws.amazon.com/kendra/latest/dg/create-index-access-control.html).
Sie geben das Benutzertoken im [UserContext](https://docs.aws.amazon.com/kendra/latest/APIReference/API_UserContext.html)Objekt an und übergeben es in der [Abfrage-API](https://docs.aws.amazon.com/kendra/latest/APIReference/API_Query.html).
Im Folgenden wird gezeigt, wie ein Benutzertoken eingefügt wird.
```
response = kendra.query(
QueryText = query,
IndexId = index,
UserToken = {
Token = "token"
})
```
Sie können Benutzer Gruppen zuordnen. Wenn Sie die Benutzerkontextfilterung verwenden, ist es nicht erforderlich, bei der Ausgabe der Abfrage alle Gruppen einzubeziehen, denen ein Benutzer angehört. Mit der [PutPrincipalMapping](https://docs.aws.amazon.com/kendra/latest/APIReference/API_PutPrincipalMapping.html)API können Sie Benutzer ihren Gruppen zuordnen. Wenn Sie die `PutPrincipalMapping` API nicht verwenden möchten, müssen Sie den Benutzernamen und alle Gruppen angeben, zu denen der Benutzer gehört, wenn Sie eine Anfrage stellen. Mithilfe des Objekts können Sie auch Zugriffsebenen von Gruppen und Benutzern in Ihrer IAM Identity Center-Identitätsquelle abrufen. [UserGroupResolutionConfiguration](https://docs.aws.amazon.com/kendra/latest/APIReference/API_UserGroupResolutionConfiguration.html)
## Nach Benutzer-ID und Gruppe filtern
Wenn Sie einen Index abfragen, können Sie die Benutzer-ID und die Gruppe verwenden, um Suchergebnisse nach dem Benutzer- oder Gruppenzugriff auf Dokumente zu filtern. Wenn Sie eine Abfrage ausgeben, werden die Benutzer- und Gruppeninformationen Amazon Kendra überprüft und die Abfrage ausgeführt. Alle für die Abfrage relevanten Dokumente, auf die der Benutzer Zugriff hat, einschließlich öffentlicher Dokumente, werden zurückgegeben.
Sie können Suchergebnisse auch nach Datenquellen filtern, auf die Benutzer und Gruppen Zugriff haben. Die Angabe einer Datenquelle ist nützlich, wenn eine Gruppe an mehrere Datenquellen gebunden ist, Sie aber möchten, dass die Gruppe nur auf Dokumente einer bestimmten Datenquelle zugreift. Beispielsweise sind die Gruppen „Forschung“, „Technik“ und „Vertrieb und Marketing“ alle an die Dokumente des Unternehmens gebunden, die in den Datenquellen Confluence und Salesforce gespeichert sind. Das Team „Vertrieb und Marketing“ benötigt jedoch nur Zugriff auf kundenbezogene Dokumente, die in Salesforce gespeichert sind. Wenn Vertriebs- und Marketingbenutzer also nach kundenbezogenen Dokumenten suchen, können sie Dokumente von Salesforce in ihren Ergebnissen sehen. Benutzern, die nicht in Vertrieb und Marketing tätig sind, werden in ihren Suchergebnissen keine Salesforce-Dokumente angezeigt.
Sie geben die Benutzer-, Gruppen- und Datenquelleninformationen im [UserContext](https://docs.aws.amazon.com/kendra/latest/APIReference/API_UserContext.html)Objekt an und übergeben diese an die [Query-API](https://docs.aws.amazon.com/kendra/latest/APIReference/API_Query.html). Die Benutzer-ID und die Liste der Gruppen und Datenquellen sollten mit dem Namen übereinstimmen, den Sie im [Principal-Objekt](https://docs.aws.amazon.com/kendra/latest/APIReference/API_Principal.html) angeben, um den Benutzer, die Gruppen und Datenquellen zu identifizieren. Mit dem `Principal` Objekt können Sie einen Benutzer, eine Gruppe oder eine Datenquelle entweder einer Zulassungsliste oder einer Verweigerungsliste für den Zugriff auf ein Dokument hinzufügen.
Sie müssen eine der folgenden Angaben machen:
+ Benutzer- und Gruppeninformationen sowie (optionale) Informationen zu Datenquellen.
+ Nur die Benutzerinformationen, wenn Sie Ihre Benutzer mithilfe der [PutPrincipalMapping](https://docs.aws.amazon.com/kendra/latest/APIReference/API_PutPrincipalMapping.html)API Gruppen und Datenquellen zuordnen. Mithilfe des Objekts können Sie auch Zugriffsebenen von Gruppen und Benutzern in Ihrer IAM Identity Center-Identitätsquelle abrufen. [UserGroupResolutionConfiguration](https://docs.aws.amazon.com/kendra/latest/APIReference/API_UserGroupResolutionConfiguration.html)
Wenn diese Informationen nicht in der Abfrage enthalten sind, werden alle Dokumente Amazon Kendra zurückgegeben. Wenn Sie diese Informationen angeben, werden nur Dokumente mit übereinstimmenden Benutzern IDs, Gruppen und Datenquellen zurückgegeben.
Im Folgenden wird gezeigt, wie Benutzer-ID, Gruppen und Datenquellen eingeschlossen werden.
```
response = kendra.query(
QueryText = query,
IndexId = index,
UserContext={'Token': 'string', 'UserId': 'string', 'Groups': [ 'string', ], 'DataSourceGroups': [ { 'GroupId': 'string', 'DataSourceId': 'string' }, ] },)
```
## Nach Benutzerattribut filtern
Wenn Sie einen Index abfragen, können Sie integrierte Attribute verwenden `_user_id` und `_group_id` Suchergebnisse nach dem Benutzer- und Gruppenzugriff auf Dokumente filtern. Sie können bis zu 100 Gruppen-IDs einrichten. Wenn Sie eine Abfrage ausgeben, werden die Benutzer- und Gruppeninformationen Amazon Kendra überprüft und die Abfrage ausgeführt. Alle für die Abfrage relevanten Dokumente, auf die der Benutzer Zugriff hat, einschließlich öffentlicher Dokumente, werden zurückgegeben.
Sie geben die Benutzer- und Gruppenattribute im [AttributeFilter](https://docs.aws.amazon.com/kendra/latest/APIReference/API_AttributeFilter.html)Objekt an und übergeben diese an die [Abfrage-API](https://docs.aws.amazon.com/kendra/latest/APIReference/API_Query.html).
Das folgende Beispiel zeigt eine Anfrage, bei der die Abfrageantwort anhand der Benutzer-ID und der Gruppen „HR“ und „IT“, zu denen der Benutzer gehört, gefiltert wird. Die Abfrage gibt jedes Dokument zurück, das den Benutzer oder die Gruppen „HR“ oder „IT“ in der Zulassungsliste enthält. Wenn der Benutzer oder eine der Gruppen auf der Sperrliste für ein Dokument steht, wird das Dokument nicht zurückgegeben.
```
response = kendra.query(
QueryText = query,
IndexId = index,
AttributeFilter = {
"OrAllFilters": [
{
"EqualsTo": {
"Key": "_user_id",
"Value": {
"StringValue": "user1"
}
}
},
{
"EqualsTo": {
"Key": "_group_ids",
"Value": {
"StringListValue": ["HR", "IT"]
}
}
}
]
}
)
```
Sie können auch angeben, auf welche Datenquelle eine Gruppe im `Principal` Objekt zugreifen kann.
**Anmerkung**
Die Benutzerkontextfilterung ist keine Authentifizierungs- oder Autorisierungssteuerung für Ihre Inhalte. Es führt keine Benutzerauthentifizierung für den Benutzer und die Gruppen durch, die an die `Query` API gesendet wurden. Es liegt an Ihrer Anwendung, sicherzustellen, dass die an die `Query` API gesendeten Benutzer- und Gruppeninformationen authentifiziert und autorisiert sind.
Für jede Datenquelle gibt es eine Implementierung der Benutzerkontextfilterung. Im folgenden Abschnitt werden die einzelnen Implementierungen beschrieben.
**Topics**
+ [
## Filterung nach Benutzertoken
](#context-filter-token)
+ [
## Nach Benutzer-ID und Gruppe filtern
](#context-filter-user-incl-datasources)
+ [
## Nach Benutzerattribut filtern
](#context-filter-attribute)
+ [
## Filterung des Benutzerkontextes für Dokumente, die direkt zu einem Index hinzugefügt wurden
](#context-filter-batch)
+ [
## Filterung des Benutzerkontextes für häufig gestellte Fragen
](#context-filter-faq)
+ [
## Filterung des Benutzerkontextes für Datenquellen
](#datasource-context-filter)
## Filterung des Benutzerkontextes für Dokumente, die direkt zu einem Index hinzugefügt wurden
Wenn Sie Dokumente mithilfe der [BatchPutDocument](https://docs.aws.amazon.com/kendra/latest/APIReference/API_BatchPutDocument.html)API direkt zu einem Index hinzufügen, Amazon Kendra werden Benutzer- und Gruppeninformationen aus dem `AccessControlList` Feld des Dokuments abgerufen. Sie stellen eine Zugriffskontrollliste (ACL) für Ihre Dokumente bereit, und die ACL wird zusammen mit Ihren Dokumenten aufgenommen.
Sie geben die ACL im [Principal-Objekt](https://docs.aws.amazon.com/kendra/latest/APIReference/API_Principal.html) als Teil des [Document-Objekts](https://docs.aws.amazon.com/kendra/latest/APIReference/API_Document.html) in der `BatchPutDocument` API an. Sie geben die folgenden Informationen an:
+ Der Zugriff, den der Benutzer oder die Gruppe haben sollte. Sie können `ALLOW` oder sagen`DENY`.
+ Der Typ der Entität. Du kannst `USER` oder sagen`GROUP`.
+ Der Name des Benutzers oder der Gruppe.
Sie können dem `AccessControlList` Feld bis zu 200 Einträge hinzufügen.
## Filterung des Benutzerkontextes für häufig gestellte Fragen
Wenn Sie einem Index [eine häufig gestellte Frage hinzufügen](https://docs.aws.amazon.com/kendra/latest/APIReference/API_CreateFaq.html), Amazon Kendra werden Benutzer- und Gruppeninformationen aus `AccessControlList` object/field der FAQ-JSON-Datei abgerufen. Sie können auch eine FAQ-CSV-Datei mit benutzerdefinierten Feldern oder Attributen für die Zugriffskontrolle verwenden.
Sie geben die folgenden Informationen an:
+ Der Zugriff, den der Benutzer oder die Gruppe haben sollte. Sie können `ALLOW` oder sagen`DENY`.
+ Der Typ der Entität. Du kannst `USER` oder sagen`GROUP`.
+ Der Name des Benutzers oder der Gruppe.
Weitere Informationen finden Sie in den [FAQ-Dateien](https://docs.aws.amazon.com/kendra/latest/dg/in-creating-faq.html).
## Filterung des Benutzerkontextes für Datenquellen
Amazon Kendra durchsucht auch Benutzer- und Gruppenzugriffskontrolllisten (ACL) von unterstützten Datenquellen-Connectors. Dies ist nützlich für die Benutzerkontextfilterung, bei der Suchergebnisse nach dem Benutzer- oder Gruppenzugriff auf Dokumente gefiltert werden.
**Wichtig**
Amazon Kendra GenAI Enterprise Edition-Indizes unterstützen nur Amazon Kendra v2.0 Datenquellenconnectors.
**Topics**
+ [
### Filterung des Benutzerkontextes für Adobe Experience Manager-Datenquellen
](#context-filter-aem)
+ [
### Filterung des Benutzerkontextes für Alfresco-Datenquellen
](#context-filter-alfresco)
+ [
### Benutzerkontextfilterung für Aurora (MySQL-) Datenquellen
](#context-filter-aurora-mysql)
+ [
### Benutzerkontextfilterung für Aurora (PostgreSQL-) Datenquellen
](#context-filter-aurora-postgresql)
+ [
### Filterung des Benutzerkontextes für Datenquellen Amazon FSx
](#context-filter-fsx)
+ [
### Filterung des Benutzerkontextes für Datenbankdatenquellen
](#context-filter-jdbc)
+ [
### Benutzerkontextfilterung für Amazon RDS (Microsoft SQL Server) -Datenquellen
](#context-filter-rds-ms-sql-server)
+ [
### Benutzerkontextfilterung für Amazon RDS (MySQL-) Datenquellen
](#context-filter-rds-mysql)
+ [
### Filterung des Benutzerkontextes für Amazon RDS (Oracle-) Datenquellen
](#context-filter-rds-oracle)
+ [
### Benutzerkontextfilterung für Amazon RDS (PostgreSQL-) Datenquellen
](#context-filter-rds-postgresql)
+ [
### Filterung des Benutzerkontextes für Datenquellen Amazon S3
](#context-filter-s3)
+ [
### Filterung des Benutzerkontextes für Box-Datenquellen
](#context-filter-box)
+ [
### Filterung des Benutzerkontextes für Confluence-Datenquellen
](#context-filter-confluence)
+ [
### Filterung des Benutzerkontextes für Dropbox-Datenquellen
](#context-filter-dropbox)
+ [
### Filterung des Benutzerkontextes für Drupal-Datenquellen
](#context-filter-drupal)
+ [
### Filterung des Benutzerkontextes für GitHub Datenquellen
](#context-filter-github)
+ [
### Filterung des Benutzerkontextes für Gmail-Datenquellen
](#context-filter-gmail)
+ [
### Filterung des Benutzerkontextes für Google Drive-Datenquellen
](#context-filter-google)
+ [
### Filterung des Benutzerkontextes für DB2 IBM-Datenquellen
](#context-filter-ibm-db2)
+ [
### Filterung des Benutzerkontextes für Jira-Datenquellen
](#context-filter-jira)
+ [
### Benutzerkontextfilterung für Microsoft Exchange-Datenquellen
](#context-filter-exchange)
+ [
### Benutzerkontextfilterung für OneDrive Microsoft-Datenquellen
](#context-filter-onedrive)
+ [
### Benutzerkontextfilterung für Microsoft OneDrive v2.0-Datenquellen
](#context-filter-onedrivev2)
+ [
### Benutzerkontextfilterung für SharePoint Microsoft-Datenquellen
](#context-filter-sharepoint-online)
+ [
### Benutzerkontextfilterung für Microsoft SQL Server-Datenquellen
](#context-filter-ms-sql-server)
+ [
### Benutzerkontextfilterung für Microsoft Teams-Datenquellen
](#context-filter-teams)
+ [
### Benutzerkontextfilterung für Microsoft Yammer-Datenquellen
](#context-filter-yammer)
+ [
### Benutzerkontextfilterung für MySQL-Datenquellen
](#context-filter-mysql)
+ [
### Filterung des Benutzerkontextes für Oracle-Datenbankdatenquellen
](#context-filter-oracle-database)
+ [
### Benutzerkontextfilterung für PostgreSQL-Datenquellen
](#context-filter-postgresql)
+ [
### Filterung des Benutzerkontextes für Quip-Datenquellen
](#context-filter-quip)
+ [
### Filterung des Benutzerkontextes für Salesforce-Datenquellen
](#context-filter-salesforce)
+ [
### Filterung des Benutzerkontextes für ServiceNow Datenquellen
](#context-filter-servicenow)
+ [
### Filterung des Benutzerkontextes für Slack-Datenquellen
](#context-filter-slack)
+ [
### Filterung des Benutzerkontextes für Zendesk-Datenquellen
](#context-filter-zendesk)
### Filterung des Benutzerkontextes für Adobe Experience Manager-Datenquellen
Wenn Sie eine Adobe Experience Manager-Datenquelle verwenden, Amazon Kendra ruft die Benutzer- und Gruppeninformationen aus der Adobe Experience Manager-Instanz ab.
Die Gruppe und der Benutzer IDs werden wie folgt zugeordnet:
+ `_group_ids`— Gruppen IDs existieren in Adobe Experience Manager-Inhalten, für die es festgelegte Zugriffsberechtigungen gibt. Sie werden anhand der Namen der Gruppen in Adobe Experience Manager zugeordnet.
+ `_user_id`— Benutzer IDs existieren in Adobe Experience Manager-Inhalten, für die es festgelegte Zugriffsberechtigungen gibt. Sie werden den Benutzer-E-Mails wie IDs in Adobe Experience Manager zugeordnet.
Sie können dem `AccessControlList` Feld bis zu 200 Einträge hinzufügen.
### Filterung des Benutzerkontextes für Alfresco-Datenquellen
Wenn Sie eine Alfresco-Datenquelle verwenden, werden die Benutzer- und Gruppeninformationen aus der Alfresco-Instanz Amazon Kendra abgerufen.
Die Gruppe und der Benutzer IDs werden wie folgt zugeordnet:
+ `_group_ids`— Gruppen IDs existieren in Alfresco für Dateien, für die Zugriffsberechtigungen festgelegt sind. Sie werden anhand der Systemnamen der Gruppen (nicht anhand der Anzeigenamen) in Alfresco zugeordnet.
+ `_user_id`— Benutzer IDs existieren in Alfresco für Dateien, für die Zugriffsberechtigungen festgelegt sind. Sie werden den Benutzer-E-Mails wie in Alfresco zugeordnet. IDs
Sie können dem Feld bis zu 200 Einträge hinzufügen. `AccessControlList`
### Benutzerkontextfilterung für Aurora (MySQL-) Datenquellen
Wenn Sie eine Aurora (MySQL-) Datenquelle verwenden, Amazon Kendra ruft Benutzer- und Gruppeninformationen aus einer Spalte in der Quelltabelle ab. Sie geben diese Spalte in der Konsole an oder verwenden das [TemplateConfiguration](https://docs.aws.amazon.com/kendra/latest/APIReference/API_TemplateConfiguration.html)Objekt als Teil der [CreateDataSource](https://docs.aws.amazon.com/kendra/latest/APIReference/API_CreateDataSource.html)API.
Eine Aurora (MySQL-) Datenbankdatenquelle hat die folgenden Einschränkungen:
+ Sie können nur eine Zulassungsliste für eine Datenbankdatenquelle angeben. Sie können keine Verweigerungsliste angeben.
+ Sie können nur Gruppen angeben. Sie können keine einzelnen Benutzer für die Zulassungsliste angeben.
+ Die Datenbankspalte muss eine Zeichenfolge sein, die eine durch Semikolons getrennte Liste von Gruppen enthält.
### Benutzerkontextfilterung für Aurora (PostgreSQL-) Datenquellen
Wenn Sie eine Aurora (PostgreSQL-) Datenquelle verwenden, Amazon Kendra ruft Benutzer- und Gruppeninformationen aus einer Spalte in der Quelltabelle ab. Sie geben diese Spalte in der Konsole an oder verwenden das [TemplateConfiguration](https://docs.aws.amazon.com/kendra/latest/APIReference/API_TemplateConfiguration.html)Objekt als Teil der [CreateDataSource](https://docs.aws.amazon.com/kendra/latest/APIReference/API_CreateDataSource.html)API.
Eine Aurora (PostgreSQL-) Datenbankdatenquelle hat die folgenden Einschränkungen:
+ Sie können nur eine Zulassungsliste für eine Datenbankdatenquelle angeben. Sie können keine Verweigerungsliste angeben.
+ Sie können nur Gruppen angeben. Sie können keine einzelnen Benutzer für die Zulassungsliste angeben.
+ Die Datenbankspalte muss eine Zeichenfolge sein, die eine durch Semikolons getrennte Liste von Gruppen enthält.
### Filterung des Benutzerkontextes für Datenquellen Amazon FSx
Wenn Sie eine Amazon FSx Datenquelle verwenden, Amazon Kendra werden Benutzer- und Gruppeninformationen aus dem Verzeichnisdienst der Amazon FSx Instanz abgerufen.
Die Amazon FSx Gruppe und der Benutzer IDs werden wie folgt zugeordnet:
+ `_group_ids`— Gruppen IDs existieren nur in Amazon FSx Dateien, für die Zugriffsberechtigungen festgelegt wurden. Sie werden anhand der Systemgruppennamen im Verzeichnisdienst von zugeordnet. Amazon FSx
+ `_user_id`— Der Benutzer IDs existiert in allen Amazon FSx Dateien, für die Zugriffsberechtigungen festgelegt wurden. Sie werden anhand der Systembenutzernamen im Verzeichnisdienst von zugeordnet. Amazon FSx
Sie können dem `AccessControlList` Feld bis zu 200 Einträge hinzufügen.
### Filterung des Benutzerkontextes für Datenbankdatenquellen
Wenn Sie eine Datenbankdatenquelle verwenden, z. B. Amazon Aurora PostgreSQL Benutzer Amazon Kendra - und Gruppeninformationen aus einer Spalte in der Quelltabelle abrufen. Sie geben diese Spalte im [AclConfiguration](https://docs.aws.amazon.com/kendra/latest/APIReference/API_AclConfiguration.html)Objekt als Teil des [DatabaseConfiguration](https://docs.aws.amazon.com/kendra/latest/APIReference/API_DatabaseConfiguration.html)Objekts in der [CreateDataSource](https://docs.aws.amazon.com/kendra/latest/APIReference/API_CreateDataSource.html)API an.
Für eine Datenbankdatenquelle gelten die folgenden Einschränkungen:
+ Sie können nur eine Zulassungsliste für eine Datenbankdatenquelle angeben. Sie können keine Verweigerungsliste angeben.
+ Sie können nur Gruppen angeben. Sie können keine einzelnen Benutzer für die Zulassungsliste angeben.
+ Die Datenbankspalte muss eine Zeichenfolge sein, die eine durch Semikolons getrennte Liste von Gruppen enthält.
### Benutzerkontextfilterung für Amazon RDS (Microsoft SQL Server) -Datenquellen
Wenn Sie eine Amazon RDS (Microsoft SQL Server-) Datenquelle verwenden, Amazon Kendra ruft Benutzer- und Gruppeninformationen aus einer Spalte in der Quelltabelle ab. Sie geben diese Spalte in der Konsole an oder verwenden das [TemplateConfiguration](https://docs.aws.amazon.com/kendra/latest/APIReference/API_TemplateConfiguration.html)Objekt als Teil der [CreateDataSource](https://docs.aws.amazon.com/kendra/latest/APIReference/API_CreateDataSource.html)API.
Eine Datenbankdatenquelle Amazon RDS (Microsoft SQL Server) hat die folgenden Einschränkungen:
+ Sie können nur eine Zulassungsliste für eine Datenbankdatenquelle angeben. Sie können keine Verweigerungsliste angeben.
+ Sie können nur Gruppen angeben. Sie können keine einzelnen Benutzer für die Zulassungsliste angeben.
+ Die Datenbankspalte muss eine Zeichenfolge sein, die eine durch Semikolons getrennte Liste von Gruppen enthält.
### Benutzerkontextfilterung für Amazon RDS (MySQL-) Datenquellen
Wenn Sie eine Amazon RDS (MySQL-) Datenquelle verwenden, Amazon Kendra ruft Benutzer- und Gruppeninformationen aus einer Spalte in der Quelltabelle ab. Sie geben diese Spalte in der Konsole an oder verwenden das [TemplateConfiguration](https://docs.aws.amazon.com/kendra/latest/APIReference/API_TemplateConfiguration.html)Objekt als Teil der [CreateDataSource](https://docs.aws.amazon.com/kendra/latest/APIReference/API_CreateDataSource.html)API.
Eine Amazon RDS (MySQL-) Datenbankdatenquelle hat die folgenden Einschränkungen:
+ Sie können nur eine Zulassungsliste für eine Datenbankdatenquelle angeben. Sie können keine Verweigerungsliste angeben.
+ Sie können nur Gruppen angeben. Sie können keine einzelnen Benutzer für die Zulassungsliste angeben.
+ Die Datenbankspalte muss eine Zeichenfolge sein, die eine durch Semikolons getrennte Liste von Gruppen enthält.
### Filterung des Benutzerkontextes für Amazon RDS (Oracle-) Datenquellen
Wenn Sie eine Amazon RDS (Oracle-) Datenquelle verwenden, Amazon Kendra ruft Benutzer- und Gruppeninformationen aus einer Spalte in der Quelltabelle ab. Sie geben diese Spalte in der Konsole an oder verwenden das [TemplateConfiguration](https://docs.aws.amazon.com/kendra/latest/APIReference/API_TemplateConfiguration.html)Objekt als Teil der [CreateDataSource](https://docs.aws.amazon.com/kendra/latest/APIReference/API_CreateDataSource.html)API.
Eine Amazon RDS (Oracle-) Datenbankdatenquelle hat die folgenden Einschränkungen:
+ Sie können nur eine Zulassungsliste für eine Datenbankdatenquelle angeben. Sie können keine Verweigerungsliste angeben.
+ Sie können nur Gruppen angeben. Sie können keine einzelnen Benutzer für die Zulassungsliste angeben.
+ Die Datenbankspalte muss eine Zeichenfolge sein, die eine durch Semikolons getrennte Liste von Gruppen enthält.
### Benutzerkontextfilterung für Amazon RDS (PostgreSQL-) Datenquellen
Wenn Sie eine Amazon RDS (PostgreSQL-) Datenquelle verwenden, Amazon Kendra ruft Benutzer- und Gruppeninformationen aus einer Spalte in der Quelltabelle ab. Sie geben diese Spalte in der Konsole an oder verwenden das [TemplateConfiguration](https://docs.aws.amazon.com/kendra/latest/APIReference/API_TemplateConfiguration.html)Objekt als Teil der [CreateDataSource](https://docs.aws.amazon.com/kendra/latest/APIReference/API_CreateDataSource.html)API.
Eine Amazon RDS (PostgreSQL-) Datenbankdatenquelle hat die folgenden Einschränkungen:
+ Sie können nur eine Zulassungsliste für eine Datenbankdatenquelle angeben. Sie können keine Verweigerungsliste angeben.
+ Sie können nur Gruppen angeben. Sie können keine einzelnen Benutzer für die Zulassungsliste angeben.
+ Die Datenbankspalte muss eine Zeichenfolge sein, die eine durch Semikolons getrennte Liste von Gruppen enthält.
### Filterung des Benutzerkontextes für Datenquellen Amazon S3
Sie fügen einem Dokument in einer Amazon S3 Datenquelle Benutzerkontextfilter hinzu, indem Sie eine dem Dokument zugeordnete Metadatendatei verwenden. Sie fügen die Informationen dem `AccessControlList` Feld im JSON-Dokument hinzu. Weitere Informationen zum Hinzufügen von Metadaten zu Dokumenten, die aus einer Amazon S3 Datenquelle indexiert wurden, finden Sie unter [S3-Dokumentmetadaten](https://docs.aws.amazon.com/kendra/latest/dg/s3-metadata.html).
Sie geben drei Informationen an:
+ Der Zugriff, den die Entität haben sollte. Sie können `ALLOW` oder sagen`DENY`.
+ Der Typ der Entität. Du kannst `USER` oder sagen`GROUP`.
+ Der Name der Entität.
Sie können dem `AccessControlList` Feld bis zu 200 Einträge hinzufügen.
### Filterung des Benutzerkontextes für Box-Datenquellen
Wenn Sie eine Box-Datenquelle verwenden, Amazon Kendra werden Benutzer- und Gruppeninformationen aus der Box-Instanz abgerufen.
Die Box-Gruppe und der Box-Benutzer IDs werden wie folgt zugeordnet:
+ `_group_ids`— In Box IDs gibt es Gruppen für Dateien, für die Zugriffsberechtigungen festgelegt sind. Sie werden anhand der Namen der Gruppen in Box zugeordnet.
+ `_user_id`— Der Benutzer IDs existiert in Box für Dateien, für die es festgelegte Zugriffsberechtigungen gibt. Sie werden anhand der Benutzer-E-Mails dem Benutzer IDs in Box zugeordnet.
Sie können dem `AccessControlList` Feld bis zu 200 Einträge hinzufügen.
### Filterung des Benutzerkontextes für Confluence-Datenquellen
Wenn Sie eine Confluence-Datenquelle verwenden, werden Benutzer- und Gruppeninformationen aus der Confluence-Instanz Amazon Kendra abgerufen.
Sie konfigurieren den Benutzer- und Gruppenzugriff auf Bereiche auf der Seite „Bereichsberechtigungen“. Für Seiten und Blogs verwenden Sie die Seite „Beschränkungen“. Weitere Informationen zu Bereichsberechtigungen finden Sie unter [Übersicht über Bereichsberechtigungen](https://confluence.atlassian.com/doc/space-permissions-overview-139521.html) auf der Confluence-Support-Website. Weitere Informationen zu Seiten- und Blogbeschränkungen finden Sie unter [Seitenbeschränkungen](https://confluence.atlassian.com/doc/page-restrictions-139414.html) auf der Confluence-Support-Website.
Die Confluence-Gruppen- und Benutzernamen werden wie folgt zugeordnet:
+ `_group_ids`— Gruppennamen sind in Bereichen, Seiten und Blogs vorhanden, für die Einschränkungen gelten. Sie werden anhand des Namens der Gruppe in Confluence zugeordnet. Gruppennamen werden immer in Kleinbuchstaben geschrieben.
+ `_user_id`— Benutzernamen sind in dem Bereich, der Seite oder dem Blog vorhanden, für den Einschränkungen gelten. Sie werden abhängig vom Typ der Confluence-Instanz, die Sie verwenden, zugeordnet.
**Für Confluence Connector v1.0**
+ Server — Das `_user_id` ist der Benutzername. Der Benutzername wird immer in Kleinbuchstaben geschrieben.
+ Cloud — Das `_user_id` ist die Konto-ID des Benutzers.
**Für Confluence Connector v2.0**
+ Server — Das `_user_id` ist der Benutzername. Der Benutzername wird immer in Kleinbuchstaben geschrieben.
+ Cloud — Das `_user_id` ist die E-Mail-ID des Benutzers.
**Wichtig**
**Damit die Benutzerkontextfilterung für Ihren Confluence-Connector korrekt funktioniert, müssen Sie sicherstellen, dass die Sichtbarkeit eines Benutzers, dem Zugriff auf eine Confluence-Seite gewährt wurde, auf Jeder gesetzt ist.** Weitere Informationen finden Sie unter [Festlegen Ihrer E-Mail-Sichtbarkeit](https://support.atlassian.com/confluence-cloud/docs/configure-user-email-visibility/) in der Dokumentation zu Atlassian Developer.
Sie können dem Feld bis zu 200 Einträge hinzufügen. `AccessControlList`
### Filterung des Benutzerkontextes für Dropbox-Datenquellen
Wenn Sie eine Dropbox-Datenquelle verwenden, Amazon Kendra ruft die Benutzer- und Gruppeninformationen aus der Dropbox-Instanz ab.
Die Gruppe und der Benutzer IDs werden wie folgt zugeordnet:
+ `_group_ids`— In Dropbox IDs gibt es Gruppen für Dateien, für die Zugriffsberechtigungen festgelegt sind. Sie werden anhand der Namen der Gruppen in Dropbox zugeordnet.
+ `_user_id`— Nutzer IDs existieren in Dropbox für Dateien, für die es festgelegte Zugriffsberechtigungen gibt. Sie werden den Benutzer-E-Mails wie IDs in Dropbox zugeordnet.
Sie können dem `AccessControlList` Feld bis zu 200 Einträge hinzufügen.
### Filterung des Benutzerkontextes für Drupal-Datenquellen
Wenn Sie eine Drupal-Datenquelle verwenden, Amazon Kendra ruft die Benutzer- und Gruppeninformationen aus der Drupal-Instanz ab.
Die Gruppe und der Benutzer IDs werden wie folgt zugeordnet:
+ `_group_ids`— In Drupal IDs gibt es Gruppen für Dateien, für die Zugriffsberechtigungen festgelegt sind. Sie werden anhand der Namen der Gruppen in Drupal zugeordnet.
+ `_user_id`— Benutzer IDs existieren in Drupal für Dateien, für die Zugriffsberechtigungen festgelegt sind. Sie werden den Benutzer-E-Mails wie IDs in Drupal zugeordnet.
Sie können dem Feld bis zu 200 Einträge hinzufügen. `AccessControlList`
### Filterung des Benutzerkontextes für GitHub Datenquellen
Wenn Sie eine GitHub Datenquelle verwenden, Amazon Kendra ruft Benutzerinformationen aus der GitHub Instanz ab.
Die GitHub Benutzer IDs werden wie folgt zugeordnet:
+ `_user_id`— Der Benutzer IDs existiert in allen GitHub Dateien, für die Zugriffsberechtigungen festgelegt wurden. Sie werden den Benutzer-E-Mails als Eingang zugeordnet. IDs GitHub
Sie können dem `AccessControlList` Feld bis zu 200 Einträge hinzufügen.
### Filterung des Benutzerkontextes für Gmail-Datenquellen
Wenn Sie eine Gmail-Datenquelle verwenden, Amazon Kendra werden die Benutzerinformationen aus der Gmail-Instanz abgerufen.
Die Nutzer IDs werden wie folgt zugeordnet:
+ `_user_id`— Nutzer IDs existieren in Gmail für Dateien, für die es festgelegte Zugriffsberechtigungen gibt. Sie werden den Benutzer-E-Mails wie IDs in Gmail zugeordnet.
Sie können dem `AccessControlList` Feld bis zu 200 Einträge hinzufügen.
### Filterung des Benutzerkontextes für Google Drive-Datenquellen
Eine Google Workspace Drive-Datenquelle gibt Nutzer- und Gruppeninformationen für Google Drive-Nutzer und -Gruppen zurück. Gruppen- und Domänenmitgliedschaft werden dem `_group_ids` Indexfeld zugeordnet. Der Google Drive-Nutzername ist dem `_user_id` Feld zugeordnet.
Wenn Sie eine oder mehrere Benutzer-E-Mail-Adressen in der `Query` API angeben, werden nur Dokumente zurückgegeben, die mit diesen E-Mail-Adressen geteilt wurden. Der folgende `AttributeFilter` Parameter gibt nur Dokumente zurück, die mit "martha@example.com" geteilt wurden.
```
"AttributeFilter": {
"EqualsTo":{
"Key": "_user_id",
"Value": {
"StringValue": "martha@example.com"
}
}
}
```
Wenn Sie in der Abfrage eine oder mehrere Gruppen-E-Mail-Adressen angeben, werden nur Dokumente zurückgegeben, die für die Gruppen freigegeben wurden. Der folgende `AttributeFilter` Parameter gibt nur Dokumente zurück, die mit der Gruppe "hr@example.com" geteilt wurden.
```
"AttributeFilter": {
"EqualsTo":{
"Key": "_group_ids",
"Value": {
"StringListValue": ["hr@example.com"]
}
}
}
```
Wenn Sie die Domäne in der Abfrage angeben, werden alle Dokumente zurückgegeben, die für die Domäne freigegeben wurden. Der folgende `AttributeFilter` Parameter gibt Dokumente zurück, die mit der Domäne „example.com“ gemeinsam genutzt werden.
```
"AttributeFilter": {
"EqualsTo":{
"Key": "_group_ids",
"Value": {
"StringListValue": ["example.com"]
}
}
}
```
Sie können dem `AccessControlList` Feld bis zu 200 Einträge hinzufügen.
### Filterung des Benutzerkontextes für DB2 IBM-Datenquellen
Wenn Sie eine DB2 IBM-Datenquelle verwenden, Amazon Kendra ruft Benutzer- und Gruppeninformationen aus einer Spalte in der Quelltabelle ab. Sie geben diese Spalte in der Konsole an oder verwenden das [TemplateConfiguration](https://docs.aws.amazon.com/kendra/latest/APIReference/API_TemplateConfiguration.html)Objekt als Teil der [CreateDataSource](https://docs.aws.amazon.com/kendra/latest/APIReference/API_CreateDataSource.html)API.
Für eine DB2 IBM-Datenbankdatenquelle gelten die folgenden Einschränkungen:
+ Sie können nur eine Zulassungsliste für eine Datenbankdatenquelle angeben. Sie können keine Verweigerungsliste angeben.
+ Sie können nur Gruppen angeben. Sie können keine einzelnen Benutzer für die Zulassungsliste angeben.
+ Die Datenbankspalte muss eine Zeichenfolge sein, die eine durch Semikolons getrennte Liste von Gruppen enthält.
### Filterung des Benutzerkontextes für Jira-Datenquellen
Wenn Sie eine Jira-Datenquelle verwenden, werden Benutzer- und Gruppeninformationen aus der Jira-Instanz Amazon Kendra abgerufen.
Die Jira-Benutzer IDs werden wie folgt zugeordnet:
+ `_user_id`— Benutzer IDs existieren in Jira für Dateien, für die es festgelegte Zugriffsberechtigungen gibt. Sie werden anhand der Benutzer-E-Mails dem Benutzer in Jira zugeordnet. IDs
Sie können dem Feld bis zu 200 Einträge hinzufügen. `AccessControlList`
### Benutzerkontextfilterung für Microsoft Exchange-Datenquellen
Wenn Sie eine Microsoft Exchange-Datenquelle verwenden, Amazon Kendra ruft die Benutzerinformationen aus der Microsoft Exchange-Instanz ab.
Die Microsoft Exchange-Benutzer IDs werden wie folgt zugeordnet:
+ `_user_id`— In Microsoft Exchange IDs gibt es Benutzerberechtigungen, mit denen Benutzer auf bestimmte Inhalte zugreifen können. Sie werden anhand der Benutzernamen wie IDs in Microsoft Exchange zugeordnet.
Sie können dem `AccessControlList` Feld bis zu 200 Einträge hinzufügen.
### Benutzerkontextfilterung für OneDrive Microsoft-Datenquellen
Amazon Kendra ruft Benutzer- und Gruppeninformationen von Microsoft ab OneDrive , wenn es die Dokumente auf der Site indexiert. Die Benutzer- und Gruppeninformationen stammen von der zugrunde liegenden SharePoint Microsoft-Website, die hostet OneDrive.
Wenn Sie einen OneDrive Benutzer oder eine Gruppe zum Filtern von Suchergebnissen verwenden, berechnen Sie die ID wie folgt:
1. Rufen Sie den Websitenamen ab. Beispiel: `https://host.onmicrosoft.com/sites/siteName.`
1. Nimm den MD5 Hash des Seitennamens. Beispiel, `430a6b90503eef95c89295c8999c7981`.
1. Erstellen Sie die Benutzer-E-Mail oder Gruppen-ID, indem Sie den MD5 Hash mit einem senkrechten Balken (\$1) und der ID verketten. Wenn ein Gruppenname beispielsweise "localGroupName„lautet, würde die Gruppen-ID wie folgt lauten:
`"430a6b90503eef95c89295c8999c7981 | localGroupName"`
**Anmerkung**
Fügen Sie vor und nach dem senkrechten Balken ein Leerzeichen ein. Der vertikale Balken wird verwendet, um sich `localGroupName` mit seinem MD5 Hash zu identifizieren.
Für den Benutzernamen "someone@host.onmicrosoft.com" würde die Benutzer-ID wie folgt lauten:
`"430a6b90503eef95c89295c8999c7981 | someone@host.onmicrosoft.com"`
Senden Sie die Benutzer- oder Gruppen-ID Amazon Kendra als `_group_id` Attribut `_user_id` oder, wenn Sie die [Abfrage-API](https://docs.aws.amazon.com/kendra/latest/APIReference/API_Query.html) aufrufen. Der AWS CLI Befehl, der eine Gruppe zum Filtern der Suchergebnisse verwendet, sieht beispielsweise so aus:
```
aws kendra query \
--index-id index ID
--query-text "query text"
--attribute-filter '{
"EqualsTo":{
"Key": "_group_id",
"Value": {"StringValue": "430a6b90503eef95c89295c8999c7981 | localGroupName"}
}}'
```
Sie können dem `AccessControlList` Feld bis zu 200 Einträge hinzufügen.
### Benutzerkontextfilterung für Microsoft OneDrive v2.0-Datenquellen
Eine Microsoft OneDrive v2.0-Datenquelle gibt Abschnitts- und Seiteninformationen aus ACL-Entitäten ( OneDrive Access Control List) zurück. Amazon Kendra verwendet die OneDrive Mandantendomäne, um eine Verbindung mit der OneDrive Instanz herzustellen, und kann dann Suchergebnisse auf der Grundlage des Benutzer- oder Gruppenzugriffs auf Abschnitte und Dateinamen filtern.
Für Standardobjekte `_group_id` werden die `_user_id` und wie folgt verwendet:
+ `_user_id`— Ihre OneDrive Microsoft-Benutzer-E-Mail-ID ist dem `_user_id` Feld zugeordnet.
+ `_group_id`— Ihre OneDrive Microsoft-Gruppen-E-Mail ist dem `_group_id` Feld zugeordnet.
Sie können dem `AccessControlList` Feld bis zu 200 Einträge hinzufügen.
### Benutzerkontextfilterung für SharePoint Microsoft-Datenquellen
Amazon Kendra ruft Benutzer- und Gruppeninformationen von Microsoft ab, SharePoint wenn es die Site-Dokumente indexiert. Um Suchergebnisse nach Benutzer- oder Gruppenzugriffen zu filtern, geben Sie Benutzer- und Gruppeninformationen an, wenn Sie die `Query` API aufrufen.
Verwenden Sie die E-Mail-Adresse des Benutzers, um nach einem Benutzernamen zu filtern. Zum Beispiel johnstiles@example.com.
Wenn Sie eine SharePoint Gruppe zum Filtern von Suchergebnissen verwenden, berechnen Sie die Gruppen-ID wie folgt:
**Für lokale Gruppen**
1. Rufen Sie den Websitenamen ab. Beispiel: `https://host.onmicrosoft.com/sites/siteName.`
1. Nimm den SHA256 Hash des Seitennamens. Beispiel, `430a6b90503eef95c89295c8999c7981`.
1. Erstellen Sie die Gruppen-ID, indem Sie den SHA256 Hash mit einem senkrechten Balken (\$1) und dem Gruppennamen verketten. Wenn der Gruppenname beispielsweise "localGroupName„lautet, würde die Gruppen-ID wie folgt lauten:
`"430a6b90503eef95c89295c8999c7981 | localGroupName"`
**Anmerkung**
Fügen Sie vor und nach dem senkrechten Balken ein Leerzeichen ein. Der vertikale Balken wird verwendet, um sich `localGroupName` mit seinem SHA256 Hash zu identifizieren.
Senden Sie die Gruppen-ID Amazon Kendra als `_group_id` Attribut an, wenn Sie die [Abfrage-API](https://docs.aws.amazon.com/kendra/latest/APIReference/API_Query.html) aufrufen. Der AWS CLI Befehl sieht zum Beispiel so aus:
```
aws kendra query \
--index-id index ID
--query-text "query text"
--attribute-filter '{
"EqualsTo":{
"Key": "_group_id",
"Value": {"StringValue": "430a6b90503eef95c89295c8999c7981 | localGroupName"}
}}'
```
**Für AD-Gruppen**
1. Verwenden Sie die AD-Gruppen-ID für die Konfiguration der Filterung von Suchergebnissen.
Senden Sie die Gruppen-ID Amazon Kendra als `_group_id` Attribut an, wenn Sie die [Abfrage-API](https://docs.aws.amazon.com/kendra/latest/APIReference/API_Query.html) aufrufen. Der AWS CLI Befehl sieht zum Beispiel so aus:
```
aws kendra query \
--index-id index ID
--query-text "query text"
--attribute-filter '{
"EqualsTo":{
"Key": "_group_id",
"Value": {"StringValue": "AD group"}
}}'
```
Sie können dem `AccessControlList` Feld bis zu 200 Einträge hinzufügen.
### Benutzerkontextfilterung für Microsoft SQL Server-Datenquellen
Wenn Sie eine Microsoft SQL Server-Datenquelle verwenden, Amazon Kendra ruft Benutzer- und Gruppeninformationen aus einer Spalte in der Quelltabelle ab. Sie geben diese Spalte in der Konsole an oder verwenden das [TemplateConfiguration](https://docs.aws.amazon.com/kendra/latest/APIReference/API_TemplateConfiguration.html)Objekt als Teil der [CreateDataSource](https://docs.aws.amazon.com/kendra/latest/APIReference/API_CreateDataSource.html)API.
Eine Microsoft SQL Server-Datenbankdatenquelle hat die folgenden Einschränkungen:
+ Sie können nur eine Zulassungsliste für eine Datenbankdatenquelle angeben. Sie können keine Verweigerungsliste angeben.
+ Sie können nur Gruppen angeben. Sie können keine einzelnen Benutzer für die Zulassungsliste angeben.
+ Die Datenbankspalte muss eine Zeichenfolge sein, die eine durch Semikolons getrennte Liste von Gruppen enthält.
### Benutzerkontextfilterung für Microsoft Teams-Datenquellen
Amazon Kendra ruft Benutzerinformationen von Microsoft Teams ab, wenn es die Dokumente indexiert. Die Benutzerinformationen stammen aus der zugrunde liegenden Microsoft Teams-Instanz.
Sie können dem `AccessControlList` Feld bis zu 200 Einträge hinzufügen.
### Benutzerkontextfilterung für Microsoft Yammer-Datenquellen
Amazon Kendra ruft Benutzerinformationen von Microsoft Yammer ab, wenn es die Dokumente indexiert. Die Benutzer- und Gruppeninformationen stammen aus der zugrunde liegenden Microsoft Yammer-Instanz.
Die Microsoft Yammer-Benutzer IDs werden wie folgt zugeordnet:
+ `_email_id`— Die Microsoft-E-Mail-ID, die dem `_user_id` Feld zugeordnet ist.
Sie können dem `AccessControlList` Feld bis zu 200 Einträge hinzufügen.
### Benutzerkontextfilterung für MySQL-Datenquellen
Wenn Sie eine MySQL-Datenquelle verwenden, Amazon Kendra ruft Benutzer- und Gruppeninformationen aus einer Spalte in der Quelltabelle ab. Sie geben diese Spalte in der Konsole an oder verwenden das [TemplateConfiguration](https://docs.aws.amazon.com/kendra/latest/APIReference/API_TemplateConfiguration.html)Objekt als Teil der [CreateDataSource](https://docs.aws.amazon.com/kendra/latest/APIReference/API_CreateDataSource.html)API.
Eine MySQL-Datenbankdatenquelle hat die folgenden Einschränkungen:
+ Sie können nur eine Zulassungsliste für eine Datenbankdatenquelle angeben. Sie können keine Verweigerungsliste angeben.
+ Sie können nur Gruppen angeben. Sie können keine einzelnen Benutzer für die Zulassungsliste angeben.
+ Die Datenbankspalte muss eine Zeichenfolge sein, die eine durch Semikolons getrennte Liste von Gruppen enthält.
### Filterung des Benutzerkontextes für Oracle-Datenbankdatenquellen
Wenn Sie eine Oracle Database-Datenquelle verwenden, Amazon Kendra ruft Benutzer- und Gruppeninformationen aus einer Spalte in der Quelltabelle ab. Sie geben diese Spalte in der Konsole an oder verwenden das [TemplateConfiguration](https://docs.aws.amazon.com/kendra/latest/APIReference/API_TemplateConfiguration.html)Objekt als Teil der [CreateDataSource](https://docs.aws.amazon.com/kendra/latest/APIReference/API_CreateDataSource.html)API.
Eine Oracle Database-Datenbankdatenquelle hat die folgenden Einschränkungen:
+ Sie können nur eine Zulassungsliste für eine Datenbankdatenquelle angeben. Sie können keine Verweigerungsliste angeben.
+ Sie können nur Gruppen angeben. Sie können keine einzelnen Benutzer für die Zulassungsliste angeben.
+ Die Datenbankspalte muss eine Zeichenfolge sein, die eine durch Semikolons getrennte Liste von Gruppen enthält.
### Benutzerkontextfilterung für PostgreSQL-Datenquellen
Wenn Sie eine PostgreSQL-Datenquelle verwenden, Amazon Kendra ruft Benutzer- und Gruppeninformationen aus einer Spalte in der Quelltabelle ab. Sie geben diese Spalte in der Konsole an oder verwenden das [TemplateConfiguration](https://docs.aws.amazon.com/kendra/latest/APIReference/API_TemplateConfiguration.html)Objekt als Teil der [CreateDataSource](https://docs.aws.amazon.com/kendra/latest/APIReference/API_CreateDataSource.html)API.
Eine PostgreSQL-Datenbankdatenquelle hat die folgenden Einschränkungen:
+ Sie können nur eine Zulassungsliste für eine Datenbankdatenquelle angeben. Sie können keine Verweigerungsliste angeben.
+ Sie können nur Gruppen angeben. Sie können keine einzelnen Benutzer für die Zulassungsliste angeben.
+ Die Datenbankspalte muss eine Zeichenfolge sein, die eine durch Semikolons getrennte Liste von Gruppen enthält.
### Filterung des Benutzerkontextes für Quip-Datenquellen
Wenn Sie eine Quip-Datenquelle verwenden, Amazon Kendra ruft die Benutzerinformationen aus der Quip-Instanz ab.
Die Quip-Benutzer IDs werden wie folgt zugeordnet:
+ `_user_id`— Der Benutzer IDs existiert in Quip für Dateien, für die es festgelegte Zugriffsberechtigungen gibt. Sie werden den Benutzer-E-Mails wie in Quip zugeordnet. IDs
Sie können dem Feld bis zu 200 Einträge hinzufügen. `AccessControlList`
### Filterung des Benutzerkontextes für Salesforce-Datenquellen
Eine Salesforce-Datenquelle gibt Benutzer- und Gruppeninformationen aus Entitäten der Salesforce-Zugriffskontrollliste (ACL) zurück. Sie können die Benutzerkontextfilterung auf Salesforce-Standardobjekte und Chatter-Feeds anwenden. Die Benutzerkontextfilterung ist für Salesforce-Wissensartikel nicht verfügbar.
Wenn Sie ein Salesforce-Feld den Feldern Dokumenttitel und Dokumenttext von Amazon Kendra zuordnen, verwendet Amazon Kendra Daten aus den Feldern Dokumenttitel und Textkörper in den Suchantworten.
Für Standardobjekte `_group_ids` werden die Zeichen `_user_id` und wie folgt verwendet:
+ `_user_id`— Der Benutzername des Salesforce-Benutzers.
+ `_group_ids`—
+ Name des Salesforce-Benutzers `Profile`
+ Name des Salesforce `Group`
+ Name des Salesforce `UserRole`
+ Name des Salesforce `PermissionSet`
Für Chatter-Feeds `_group_ids` werden die `_user_id` und wie folgt verwendet:
+ `_user_id`— Der Benutzername des Salesforce-Benutzers. Nur verfügbar, wenn das Element im Feed des Benutzers veröffentlicht wurde.
+ `_group_ids`— Gruppen IDs werden wie folgt verwendet. Nur verfügbar, wenn das Feed-Element in einer Chatter- oder Kollaborationsgruppe gepostet wurde.
+ Der Name der Chatter- oder Kollaborationsgruppe.
+ Wenn die Gruppe öffentlich ist, `PUBLIC:ALL`.
Sie können dem `AccessControlList` Feld bis zu 200 Einträge hinzufügen.
### Filterung des Benutzerkontextes für ServiceNow Datenquellen
Die Benutzerkontextfilterung für ServiceNow wird nur für die TemplateConfiguration API und ServiceNow Connector v2.0 unterstützt. ServiceNowConfiguration API und ServiceNow Connector v1.0. unterstützen keine Benutzerkontextfilterung.
Wenn Sie eine ServiceNow Datenquelle verwenden, Amazon Kendra ruft die Benutzer- und Gruppeninformationen aus der ServiceNow Instanz ab.
Die Gruppe und der Benutzer IDs werden wie folgt zugeordnet:
+ `_group_ids`— Gruppen IDs existieren nur in ServiceNow Dateien, für die Zugriffsberechtigungen festgelegt wurden. Sie werden anhand der Rollennamen von `sys_ids` in zugeordnet. ServiceNow
+ `_user_id`— Der Benutzer ist in allen ServiceNow Dateien IDs vorhanden, für die Zugriffsberechtigungen festgelegt wurden. Sie werden den Benutzer-E-Mails als Eingang zugeordnet. IDs ServiceNow
Sie können dem `AccessControlList` Feld bis zu 200 Einträge hinzufügen.
### Filterung des Benutzerkontextes für Slack-Datenquellen
Wenn du eine Slack-Datenquelle verwendest, werden die Benutzerinformationen von der Slack-Instanz Amazon Kendra abgerufen.
Die Slack-Benutzer IDs werden wie folgt zugeordnet:
+ `_user_id`— Benutzer IDs existieren in Slack in Nachrichten und Channels, für die es festgelegte Zugriffsberechtigungen gibt. Sie werden den Benutzer-E-Mails wie in Slack zugeordnet. IDs
Du kannst dem Feld bis zu 200 Einträge hinzufügen. `AccessControlList`
### Filterung des Benutzerkontextes für Zendesk-Datenquellen
Wenn Sie eine Zendesk-Datenquelle verwenden, Amazon Kendra ruft die Benutzer- und Gruppeninformationen aus der Zendesk-Instanz ab.
Die Gruppe und der Benutzer IDs werden wie folgt zugeordnet:
+ `_group_ids`— Gruppen IDs existieren in Zendesk-Tickets und Beiträgen, für die es festgelegte Zugriffsberechtigungen gibt. Sie werden anhand der Gruppennamen in Zendesk zugeordnet.
+ `_user_id`— Gruppen IDs existieren in Zendesk-Tickets und Beiträgen, für die es festgelegte Zugriffsberechtigungen gibt. Sie werden den Benutzer-E-Mails wie in Zendesk zugeordnet. IDs
Sie können dem Feld bis zu 200 Einträge hinzufügen. `AccessControlList`
# Antworten und Antworttypen abfragen
**Anmerkung**
Die Funktionsunterstützung variiert je nach Indextyp und verwendeter Such-API. Informationen darüber, ob diese Funktion für den von Ihnen verwendeten Indextyp und die Such-API unterstützt wird, finden Sie unter [Indextypen](https://docs.aws.amazon.com/kendra/latest/dg/hiw-index-types.html).
Amazon Kendra unterstützt verschiedene Abfrageantworten und Antworttypen.
## Antworten abfragen
Ein Aufruf der [Query](https://docs.aws.amazon.com/kendra/latest/APIReference/API_Query.html) API gibt Informationen über die Ergebnisse einer Suche zurück. Die Ergebnisse befinden sich in einem Array von [QueryResultItem](https://docs.aws.amazon.com/kendra/latest/APIReference/API_QueryResultItem.html)Objekten (`ResultItems`). Jedes `QueryResultItem` enthält eine Zusammenfassung des Ergebnisses. Mit dem Abfrageergebnis verknüpfte Dokumentattribute sind enthalten.
**Zusammenfassende Informationen**
Die zusammenfassenden Informationen variieren je nach Art des Ergebnisses. In jedem Fall enthält es Dokumenttext, der dem Suchbegriff entspricht. Es enthält auch Hervorhebungsinformationen, mit denen Sie den Suchtext in der Ausgabe Ihrer Anwendung hervorheben können. Wenn der Suchbegriff beispielsweise *wie hoch ist die Space Needle?* , die zusammenfassenden Informationen beinhalten die Textposition für die Wörter *Höhe* und *Space Needle*. Informationen zu Antworttypen finden Sie unter[Antworten und Antworttypen abfragen](#query-responses-types).
**Dokumentattribute**
Jedes Ergebnis enthält Dokumentattribute für das Dokument, das einer Abfrage entspricht. Einige der Attribute sind vordefiniert, z. B. `DocumentId``DocumentTitle`, und`DocumentUri`. Andere sind benutzerdefinierte Attribute, die Sie definieren. Sie können Dokumentattribute verwenden, um die Antwort von der `Query` API zu filtern. Beispielsweise möchten Sie möglicherweise nur die Dokumente verwenden, die von einem bestimmten Autor oder einer bestimmten Version eines Dokuments verfasst wurden. Weitere Informationen finden Sie unter [Filterung und Facettensuche](filtering.md). Sie geben Dokumentattribute an, wenn Sie Dokumente zu einem Index hinzufügen. Weitere Informationen finden Sie unter [Benutzerdefinierte Felder oder Attribute](https://docs.aws.amazon.com/kendra/latest/dg/custom-attributes.html).
Im Folgenden finden Sie einen JSON-Beispielcode für ein Abfrageergebnis. Notieren Sie sich die Dokumentattribute in `DocumentAttributes` und`AdditionalAttributes`.
```
{
"QueryId": "query-id",
"ResultItems": [
{
"Id": "result-id",
"Type": "ANSWER",
"AdditionalAttributes": [
{
"Key": "AnswerText",
"ValueType": "TEXT_WITH_HIGHLIGHTS_VALUE",
"Value": {
"TextWithHighlightsValue": {
"Text": "text",
"Highlights": [
{
"BeginOffset": 55,
"EndOffset": 90,
"TopAnswer": false
}
]
}
}
}
],
"DocumentId": "document-id",
"DocumentTitle": {
"Text": "title"
},
"DocumentExcerpt": {
"Text": "text",
"Highlights": [
{
"BeginOffset": 0,
"EndOffset": 300,
"TopAnswer": false
}
]
},
"DocumentURI": "uri",
"DocumentAttributes": [],
"ScoreAttributes": "score",
"FeedbackToken": "token"
},
{
"Id": "result-id",
"Type": "ANSWER",
"Format": "TABLE",
"DocumentId": "document-id",
"DocumentTitle": {
"Text": "title"
},
"TableExcerpt": {
"Rows": [{
"Cells": [{
"Header": true,
"Highlighted": false,
"TopAnswer": false,
"Value": "value"
}, {
"Header": true,
"Highlighted": false,
"TopAnswer": false,
"Value": "value"
}, {
"Header": true,
"Highlighted": false,
"TopAnswer": false,
"Value": "value"
}, {
"Header": true,
"Highlighted": false,
"TopAnswer": false,
"Value": "value"
}]
}, {
"Cells": [{
"Header": false,
"Highlighted": false,
"TopAnswer": false,
"Value": "value"
}, {
"Header": false,
"Highlighted": false,
"TopAnswer": false,
"Value": "value"
}, {
"Header": false,
"Highlighted": true,
"TopAnswer": true,
"Value": "value"
}, {
"Header": false,
"Highlighted": false,
"TopAnswer": false,
"Value": "value"
]}
}],
"TotalNumberofRows": number
},
"DocumentURI": "uri",
"ScoreAttributes": "score",
"FeedbackToken": "token"
},
{
"Id": "result-id",
"Type": "DOCUMENT",
"AdditionalAttributes": [],
"DocumentId": "document-id",
"DocumentTitle": {
"Text": "title",
"Highlights": []
},
"DocumentExcerpt": {
"Text": "text",
"Highlights": [
{
"BeginOffset": 74,
"EndOffset": 77,
"TopAnswer": false
}
]
},
"DocumentURI": "uri",
"DocumentAttributes": [
{
"Key": "_source_uri",
"Value": {
"StringValue": "uri"
}
}
],
"ScoreAttributes": "score",
"FeedbackToken": "token",
}
],
"FacetResults": [],
"TotalNumberOfResults": number
}
```
## Arten von Antworten
Amazon Kendra gibt drei Arten von Abfrageantworten zurück.
+ Antwort (beinhaltet Tabellenantwort)
+ Dokument
+ Frage und Antwort
Der Typ der Antwort wird im `Type` Antwortfeld des [QueryResultItem](https://docs.aws.amazon.com/kendra/latest/APIReference/API_QueryResultItem.html)Objekts zurückgegeben.
### Antwort
Amazon Kendra hat eine oder mehrere Antworten auf Fragen in der Antwort erkannt. Ein Faktoid ist die Antwort auf eine „Wer“, „Was“, „Wann“ oder „Wo“ -Frage, z. B. „*Wo ist das nächstgelegene Servicecenter*?“ Amazon Kendra gibt Text im Index zurück, der der Abfrage am besten entspricht. Der Text befindet sich im `AnswerText` Feld und enthält hervorgehobene Informationen für den Suchbegriff im Antworttext. `AnswerText`enthält den vollständigen Dokumentauszug mit hervorgehobenem Text und `DocumentExcerpt` den gekürzten (290 Zeichen) Dokumentauszug mit hervorgehobenem Text.
Amazon Kendra gibt nur eine Antwort pro Dokument zurück, und das ist die Antwort mit der höchsten Zuverlässigkeit. Um mehrere Antworten aus einem Dokument zurückzugeben, müssen Sie das Dokument in mehrere Dokumente aufteilen.
```
{
'AnswerText': {
'TextWithHighlights': [
{
'BeginOffset': 271,
'EndOffset': 279,
'TopAnswer': False
},
{
'BeginOffset': 481,
'EndOffset': 489,
'TopAnswer': False
},
{
'BeginOffset': 547,
'EndOffset': 555,
'TopAnswer': False
},
{
'BeginOffset': 764,
'EndOffset': 772,
'TopAnswer': False
}
],
'Text': 'Asynchronousoperationscan\n''alsoprocess\n''documentsthatareinPDF''format.UsingPDFformatfilesallowsyoutoprocess''multi-page\n''documents.\n''Forinformationabouthow''AmazonTextractrepresents\n''documentsasBlockobjects,
''seeDocumentsandBlockObjects.\n''\n''\n''\n''Forinformationaboutdocument''limits,
seeLimitsinAmazonTextract.\n''\n''\n''\n''TheAmazonTextractsynchronous''operationscanprocessdocumentsstoredinanAmazon\n''S3Bucketoryoucanpass''base64encodedimagebytes.\n''Formoreinformation,
see''CallingAmazonTextractSynchronousOperations.''Asynchronousoperationsrequireinputdocuments\n''tobesuppliedinanAmazon''S3Bucket.'
},
'DocumentExcerpt': {
'Highlights': [
{
'BeginOffset': 0,
'EndOffset': 300,
'TopAnswer': False
}
],
'Text': 'Asynchronousoperationscan\n''alsoprocess\n''documentsthatareinPDF''format.UsingPDFformatfilesallowsyoutoprocess''multi-page\n''documents.\n''ForinformationabouthowAmazon''Textractrepresents\n'''
},
'Type': 'ANSWER'
}
```
### Dokument
Amazon Kendra gibt Dokumente mit Rangfolge für diejenigen zurück, die dem Suchbegriff entsprechen. Die Rangfolge basiert auf dem Vertrauen, Amazon Kendra das Sie in die Richtigkeit des Suchergebnisses haben. Informationen über das passende Dokument werden in der zurückgegeben [QueryResultItem](https://docs.aws.amazon.com/kendra/latest/APIReference/API_QueryResultItem.html). Es enthält den Titel des Dokuments. Der Auszug enthält hervorgehobene Informationen für den Suchtext und den Abschnitt mit dem passenden Text im Dokument. Der URI für übereinstimmende Dokumente befindet sich im `SourceURI` Dokumentattribut. Das folgende JSON-Beispiel zeigt die Dokumentzusammenfassung für ein passendes Dokument.
```
{
'DocumentTitle': {
'Highlights': [
{
'BeginOffset': 7,
'EndOffset': 15,
'TopAnswer': False
},
{
'BeginOffset': 97,
'EndOffset': 105,
'TopAnswer': False
}
],
'Text': 'AmazonTextractAPIPermissions: Actions,
\n''Permissions,
andResourcesReference-''AmazonTextract'
},
'DocumentExcerpt': {
'Highlights': [
{
'BeginOffset': 68,
'EndOffset': 76,
'TopAnswer': False
},
{
'BeginOffset': 121,
'EndOffset': 129,
'TopAnswer': False
}
],
'Text': '...LoggingandMonitoring\tMonitoring\n''\tCloudWatchMetricsforAmazonTextract\n''\tLoggingAmazonTextractAPICallswithAWSCloudTrail\n''\tAPIReference\tActions\tAnalyzeDocument\n''\tDetectDocumentText\n''\tGetDocumentAnalysis...'
},
'Type': 'DOCUMENT'
}
```
### Frage und Antwort
Eine Antwort mit Frage und Antwort wird zurückgegeben, wenn eine Frage mit einer der häufig gestellten Fragen in Ihrem Index Amazon Kendra übereinstimmt. Die Antwort enthält die passende Frage und Antwort in dem [QueryResultItem](https://docs.aws.amazon.com/kendra/latest/APIReference/API_QueryResultItem.html)Feld. Sie enthält auch Informationen zur Hervorhebung von Abfragebegriffen, die in der Abfragezeichenfolge erkannt wurden. Die folgende JSON-Datei zeigt eine Frage und eine Antwort. Beachten Sie, dass die Antwort den Fragetext enthält.
```
{
'AnswerText': {
'TextWithHighlights': [
],
'Text': '605feet'
},
'DocumentExcerpt': {
'Highlights': [
{
'BeginOffset': 0,
'EndOffset': 8,
'TopAnswer': False
}
],
'Text': '605feet'
},
'Type': 'QUESTION_ANSWER',
'QuestionText': {
'Highlights': [
{
'BeginOffset': 12,
'EndOffset': 18,
'TopAnswer': False
},
{
'BeginOffset': 26,
'EndOffset': 31,
'TopAnswer': False
},
{
'BeginOffset': 32,
'EndOffset': 38,
'TopAnswer': False
}
],
'Text': 'whatistheheightoftheSpaceNeedle?'
}
}
```
Informationen zum Hinzufügen von Frage- und Antworttext zu einem Index finden Sie unter [Häufig gestellte Fragen erstellen](https://docs.aws.amazon.com/kendra/latest/dg/in-creating-faq.html).
# Antworten optimieren und sortieren
**Anmerkung**
Die Funktionsunterstützung variiert je nach Indextyp und verwendeter Such-API. Informationen darüber, ob diese Funktion für den von Ihnen verwendeten Indextyp und die Such-API unterstützt wird, finden Sie unter [Indextypen](https://docs.aws.amazon.com/kendra/latest/dg/hiw-index-types.html).
Sie können die Auswirkung eines Felds oder Attributs auf die Suchrelevanz mithilfe der Relevanzoptimierung ändern. Sie können die Suchergebnisse auch nach einem bestimmten Attribut oder Feld sortieren.
**Topics**
+ [
## Antworten optimieren
](#tuning-responses)
+ [
## Antworten sortieren
](#sorting-responses)
## Antworten optimieren
Sie können die Auswirkung eines Felds oder Attributs auf die Suchrelevanz mithilfe der Relevanzoptimierung ändern. Um die Relevanzoptimierung schnell zu testen, verwenden Sie die [Abfrage-API](https://docs.aws.amazon.com/kendra/latest/APIReference/API_Query.html), um Optimierungskonfigurationen in der Abfrage zu übergeben. Anschließend können Sie die verschiedenen Suchergebnisse sehen, die Sie aus verschiedenen Konfigurationen erhalten. Die Optimierung der Relevanz auf Abfrageebene wird in der Konsole nicht unterstützt. Sie können Felder oder Attribute, die vom Typ sind, auch nur `StringList` auf Indexebene optimieren. Weitere Informationen finden Sie unter [Suchrelevanz optimieren](https://docs.aws.amazon.com/kendra/latest/dg/tuning.html).
Standardmäßig werden Abfrageantworten nach dem Relevanzwert sortiert, der für jedes Ergebnis in der Antwort Amazon Kendra ausschlaggebend ist.
Sie können die Ergebnisse für alle integrierten oder benutzerdefinierten Typen attribute/field der folgenden Typen optimieren:
+ Wert des Datums
+ Langer Wert
+ Zeichenfolge\$1Wert
Sie können Attribute des folgenden Typs nicht sortieren:
+ Werte in der Zeichenkettenliste
**Ordnen und optimieren Sie die Dokumentergebnisse (AWS SDK)**
Setzen Sie den `Searchable` Parameter auf true, um die Konfiguration der Dokumentmetadaten zu verbessern.
Um ein Attribut in einer Abfrage zu optimieren, legen Sie den `DocumentRelevanceOverrideConfigurations` `Query` API-Parameter fest und geben Sie den Namen des zu optimierenden Attributs an.
Das folgende JSON-Beispiel zeigt ein `DocumentRelevanceOverrideConfigurations` Objekt, das die Optimierung für das Attribut „department“ im Index überschreibt.
```
"DocumentRelevanceOverrideConfigurations" : [
"Name": "department",
"Relevance": {
"Importance": 1,
"ValueImportanceMap": {
"IT": 3,
"HR": 7
}
}
]
```
## Antworten sortieren
Amazon Kendra verwendet das Sortierattribut oder das Sortierfeld als Teil der Kriterien für die von der Abfrage zurückgegebenen Dokumente. Beispielsweise enthalten die Ergebnisse, die von einer nach „\$1created\$1at“ sortierten Abfrage zurückgegeben werden, möglicherweise nicht dieselben Ergebnisse wie eine nach „\$1version“ sortierte Abfrage.
Standardmäßig werden Abfrageantworten nach dem Relevanzwert sortiert, der für jedes Ergebnis in der Antwort Amazon Kendra ausschlaggebend ist. Um die Sortierreihenfolge zu ändern, machen Sie ein Dokumentattribut sortierbar und konfigurieren Sie es dann so, dass dieses Attribut Amazon Kendra zum Sortieren von Antworten verwendet wird.
Sie können Ergebnisse nach jedem integrierten oder benutzerdefinierten Typ attribute/field der folgenden Typen sortieren:
+ Wert des Datums
+ Langer Wert
+ Zeichenfolge\$1Wert
Sie können Attribute des folgenden Typs nicht sortieren:
+ Werte in der Zeichenkettenliste
Sie können in jeder Abfrage nach einem oder mehreren Dokumentattributen sortieren. Abfragen geben 100 Ergebnisse zurück. Wenn weniger als 100 Dokumente mit festgelegtem Sortierattribut vorhanden sind, werden Dokumente ohne Wert für das Sortierattribut am Ende der Ergebnisse zurückgegeben, sortiert nach Relevanz für die Abfrage.
**Um Dokumentergebnisse zu sortieren (AWS SDK)**
1. Um die [UpdateIndex](https://docs.aws.amazon.com/kendra/latest/APIReference/API_UpdateIndex.html)API zu verwenden, um ein Attribut sortierbar zu machen, setzen Sie den `Sortable` Parameter auf`true`. Das folgende JSON-Beispiel verwendet`DocumentMetadataConfigurationUpdates`, um dem Index ein Attribut namens „Department“ hinzuzufügen und es sortierbar zu machen.
```
"DocumentMetadataConfigurationUpdates": [
{
"Name": "Department",
"Type": "STRING_VALUE",
"Search": {
"Sortable": "true"
}
}
]
```
1. Um ein sortierbares Attribut in einer Abfrage zu verwenden, legen Sie den `SortingConfiguration` Parameter der [Abfrage-API](https://docs.aws.amazon.com/kendra/latest/APIReference/API_Query.html) fest. Geben Sie den Namen des zu sortierenden Attributs an und ob die Antwort in aufsteigender oder absteigender Reihenfolge sortiert werden soll.
Das folgende JSON-Beispiel zeigt den `SortingConfiguration` Parameter, mit dem Sie die Ergebnisse einer Abfrage in aufsteigender Reihenfolge nach dem Attribut „Department“ sortieren.
```
"SortingConfiguration": {
"DocumentAttributeKey": "Department",
"SortOrder": "ASC"
}
```
1. Um mehr als ein sortierbares Attribut in einer Abfrage zu verwenden, legen Sie den `SortingConfigurations` Parameter der [Abfrage-API](https://docs.aws.amazon.com/kendra/latest/APIReference/API_Query.html) fest. Sie können bis zu 3 Felder einrichten, nach denen die Ergebnisse sortiert Amazon Kendra werden sollen. Sie können auch angeben, ob die Ergebnisse in aufsteigender oder absteigender Reihenfolge sortiert werden sollen. Das Kontingent für Sortierfelder kann erhöht werden.
Wenn Sie keine Sortierkonfiguration angeben, werden die Ergebnisse nach der Relevanz sortiert, die für das Ergebnis Amazon Kendra ausschlaggebend ist. Bei Gleichstand bei der Sortierung der Ergebnisse werden die Ergebnisse nach Relevanz sortiert.
Das folgende JSON-Beispiel zeigt den `SortingConfigurations` Parameter, mit dem Sie die Ergebnisse einer Abfrage nach den Attributen „Name“ und „Preis“ in aufsteigender Reihenfolge sortieren.
```
"CollapseConfiguration" : {
"DocumentAttributeKey": "Name",
"SortingConfigurations": [
{
"DocumentAttributeKey": "Price",
"SortOrder": "ASC"
}
],
"MissingAttributeKeyStrategy": "IGNORE"
}
```
**Um Dokumentergebnisse zu sortieren (Konsole)**
**Anmerkung**
Die Sortierung mit mehreren Attributen wird derzeit von der AWS-Managementkonsole nicht unterstützt.
1. Um ein Attribut in der Konsole sortierbar zu machen, wählen Sie in der **Attributdefinition Sortierbar** aus. Sie können ein Attribut sortierbar machen, wenn Sie das Attribut erstellen, oder Sie können es später ändern.
1. Um eine Abfrageantwort in der Konsole zu sortieren, wählen Sie im Menü Sortieren das Attribut aus, nach dem die Antwort **sortiert** werden soll. In der Liste werden nur Attribute angezeigt, die bei der Konfiguration der Datenquelle als sortierbar markiert wurden.
# Abfrageergebnisse reduzieren/erweitern
**Anmerkung**
Die Funktionsunterstützung variiert je nach Indextyp und verwendeter Such-API. Informationen darüber, ob diese Funktion für den von Ihnen verwendeten Indextyp und die Such-API unterstützt wird, finden Sie unter [Indextypen](https://docs.aws.amazon.com/kendra/latest/dg/hiw-index-types.html).
Wenn Sie eine Verbindung Amazon Kendra zu Ihren Daten herstellen, durchsucht es die [Metadatenattribute von Dokumenten](https://docs.aws.amazon.com/kendra/latest/dg/hiw-document-attributes.html) — wie `_document_title``_created_at`, und `_document_id` — und verwendet diese Attribute oder Felder, um erweiterte Suchfunktionen während der Abfrage bereitzustellen.
Amazon Kendra Mit der Funktion zum Reduzieren und Erweitern von Abfrageergebnissen können Sie Suchergebnisse anhand eines gemeinsamen Dokumentattributs gruppieren und sie — entweder reduziert oder teilweise erweitert — unter einem bestimmten Hauptdokument anzeigen.
**Anmerkung**
[Die Funktion zum Reduzieren und Erweitern von Abfrageergebnissen ist derzeit nur über die API verfügbar.Amazon Kendra](https://docs.aws.amazon.com/kendra/latest/APIReference/welcome.html)
Dies ist in den folgenden Suchsituationen nützlich:
+ In Dokumenten in Ihrem Index gibt es mehrere Versionen von Inhalten. Wenn Ihr Endbenutzer den Index abfragt, möchten Sie, dass er die relevanteste Version des Dokuments mit Duplikaten hidden/collapsed. For example, if your index contains multiple versions of a document named "NYC leave policy" you can choose to collapse the documents for the specific groups "HR" and "Legal" using the "Type" attribute/field sieht.
![\[Beispiel 1\]](http://docs.aws.amazon.com/de_de/kendra/latest/dg/images/expand-collapse-1.png)
+ Ihr Index enthält mehrere Dokumente mit eindeutigen Informationen zu einer Art von Artikel oder Objekt, z. B. zu einem Produktinventar. Um Artikelinformationen bequem zu erfassen und zu sortieren, möchten Sie, dass Endbenutzer auf alle Dokumente, die mit einem Artikel oder Objekt verknüpft sind, als ein Suchergebnis zugreifen können. Im Beispiel unten werden bei einer Kundensuche nach „Hemden mit Animal-Print“ Ergebnisse angezeigt, die nach Namen gruppiert und nach aufsteigender Preisreihenfolge sortiert sind.
![\[Beispiel 2\]](http://docs.aws.amazon.com/de_de/kendra/latest/dg/images/expand-collapse-2.png)
## Ergebnisse werden zusammengeklappt
Um ähnliche oder verwandte Dokumente zu gruppieren, müssen Sie das Attribut angeben, nach dem die Anzeige reduziert werden soll (Sie können beispielsweise collapse/group Dokumente nach`_category`). Rufen Sie dazu die [Abfrage-API](https://docs.aws.amazon.com/kendra/latest/APIReference/API_Query.html) auf und verwenden Sie das Objekt, um das [CollapseConfiguration](https://docs.aws.amazon.com/kendra/latest/APIReference/API_CollapseConfiguration.html)Objekt zu spezifizieren, auf das der Kollaps angewendet werden `DocumentAttributeKey` soll. Das `DocumentAttributeKey` steuert, bei welchen Feldern die Suchergebnisse ausgeblendet werden. Zu den unterstützten Attributschlüsselfeldern gehören `String` und`Number`. `String list`und `Date` type werden nicht unterstützt.
## Ein Hauptdokument mithilfe der Sortierreihenfolge auswählen
Um das Hauptdokument so zu konfigurieren, dass es für eine reduzierte Gruppe angezeigt wird, verwenden Sie den `SortingConfigurations` Parameter unter [CollapseConfiguration](https://docs.aws.amazon.com/kendra/latest/APIReference/API_CollapseConfiguration.html). Um beispielsweise die neueste Version eines Dokuments abzurufen, würden Sie jede reduzierte Gruppe nach sortieren`_version`. Sie können bis zu 3 Daten angeben, nach attributes/fields denen sortiert werden soll, und für jede attribute/field Verwendung eine Sortierreihenfolge angeben`SortingConfigurations`. Sie können eine Erhöhung des Kontingents für die Anzahl der Sortierattribute beantragen.
Amazon Kendra Sortiert Abfrageantworten standardmäßig nach der Relevanzbewertung, die für jedes Ergebnis in der Antwort ermittelt wird. Um die Standardsortierreihenfolge zu ändern, machen Sie die Dokumentattribute sortierbar und konfigurieren Sie dann, dass diese Attribute Amazon Kendra zum Sortieren von Antworten verwendet werden. Weitere Informationen finden Sie unter [Antworten sortieren](https://docs.aws.amazon.com/kendra/latest/dg/tuning-sorting-responses.html#sorting-responses).
## Schlüsselstrategie für das Dokument fehlt
Wenn Ihr Dokument keinen Wert für das Attribut „Ausblenden“ hat, Amazon Kendra bietet es drei Anpassungsoptionen:
+ Wählen Sie `COLLAPSE` alle Dokumente mit Nullwerten oder fehlenden Werten in einer Gruppe aus. Dies ist die Standardkonfiguration.
+ Wählen Sie `IGNORE` Dokumente mit Nullwerten oder fehlenden Werten aus. Ignorierte Dokumente werden nicht in den Abfrageergebnissen angezeigt.
+ Ordnen Sie `EXPAND` jedes Dokument mit einem Nullwert oder einem fehlenden Wert in eine eigene Gruppe zu.
## Erweiterung der Ergebnisse
Mithilfe des `Expand` Parameters im [CollapseConfiguration](https://docs.aws.amazon.com/kendra/latest/APIReference/API_CollapseConfiguration.html)Objekt können Sie wählen, ob zusammengeklappte Suchergebnisgruppen erweitert werden sollen. Bei erweiterten Ergebnissen wird dieselbe Sortierreihenfolge beibehalten, die bei der Auswahl des Hauptdokuments für die Gruppe verwendet wurde.
Um die Anzahl der zusammengeklappten Suchergebnisgruppen zu konfigurieren, die erweitert werden sollen, verwenden Sie den `MaxResultItemstoExpand` Parameter im [ExpandConfiguration](https://docs.aws.amazon.com/kendra/latest/APIReference/API_ExpandConfiguration.html)Objekt. Wenn Sie diesen Wert beispielsweise auf 10 setzen, verfügen nur die ersten 10 von 100 Ergebnisgruppen über die Erweiterungsfunktion.
Verwenden Sie den `MaxExpandResultsPerItem` Parameter, um die Anzahl der erweiterten Ergebnisse zu konfigurieren, die pro reduziertem Hauptdokument angezeigt werden sollen. Wenn Sie diesen Wert beispielsweise auf 3 setzen, werden maximal 3 Ergebnisse pro reduzierter Gruppe angezeigt.
## Interaktionen mit anderen Amazon Kendra Funktionen
+ Das Reduzieren und Erweitern von Ergebnissen hat keine Auswirkungen auf die Anzahl der Facetten und wirkt sich auch nicht auf die Gesamtzahl der angezeigten Ergebnisse aus.
+ Amazon Kendra [Ausgewählte Suchergebnisse](https://docs.aws.amazon.com/kendra/latest/dg/featured-results.html) werden auch dann nicht ausgeblendet, wenn sie denselben Feldwert wie das von Ihnen konfigurierte Ausblendfeld haben.
+ Das Reduzieren und Erweitern von Ergebnissen gilt nur für Ergebnisse des Typs`DOCUMENT`.