Suche

Web-Service-Methoden › Knowledge Management › Knowledge Management – Allgemeine Methoden › Suche

Suche

Die folgenden Parameter gelten für die Methode „search“:

Parameter	Typ	Beschreibung
SID	Ganzzahl	Gibt die Sitzung an, die durch die Anmeldung abgerufen wurde.
Problem	Zeichenfolge	Gibt die Problembeschreibung an, für die Lösungen gefunden werden sollen.
resultSize	Ganzzahl	Gibt die Anzahl der Dokumente an, aus denen detaillierte Informationen abgerufen werden sollen. Für die übrigen Dokumente werden lediglich die IDs zurückgegeben. Auf ausführliche Informationen zu diesen Dokumenten kann zu einem späteren Zeitpunkt anhand der Methode „getDocumentsByIDs()“ zugegriffen werden. Der Standardwert ist 10.
propertyList	Zeichenfolge	Gibt die durch Kommas getrennte Liste der Datenbankfelder an, aus denen Informationen abgerufen werden sollen. Die folgenden Felder werden unabhängig vom Parameter „propertyList“ immer zurückgegeben: ID DOC_TYPE_ID
sortBy	Zeichenfolge	Gibt das Datenbankfeld an, das Sie zum Sortieren der Ergebnisse verwenden möchten. Mehrfache Sortierfelder werden nicht unterstützt. Der Standardwert ist RELEVANCE. Wenn die ID als sekundäres Sortierungskriterium verwendet wird, werden die Ergebnisse immer sortiert. Eine gültige Sortiereigenschaft finden Sie unter „faq-Methode“.
descending	Boolescher Wert	Gibt einen für die Sortierung der Ergebnisse in absteigender Reihenfolge verfügbaren Indikator an.
relatedCategories	Boolescher Wert	Gibt eine Liste mit allen verbundenen Kategorien für die gefundenen Dokumente zurück.
searchType	Ganzzahl	Art der durchzuführenden Suche: 1 = Suche in natürlicher Sprache (Natural Language Search, NLS) 2 = Knowledge Management-Suche
matchType	Ganzzahl	Gibt den Übereinstimmungstyp an: 0 = Übereinstimmungstyp OR 1 = Übereinstimmungstyp AND 2 = Genaue Übereinstimmung Hinweis: Bei Auswahl von NLS für den Parameter "searchType" sind nur die Übereinstimmungstypen OR und AND gültig.
searchField	Ganzzahl	Gibt die binäre Kombination von zu durchsuchenden Feldern an: Titel = 1 Zusammenfassung = 2 Problem = 4 Lösung = 8 Beispielsweise geben Sie zum Durchsuchen aller Felder den Wert 15 an (= 1+2+4+8). Um nur in der Zusammenfassung und im Problem zu suchen, geben Sie 6 an (= 2+4). Hinweis: Standardmäßig wird im Problem gesucht. Wenn Sie für den Parameter „searchType“ NLS festlegen, wird der Parameter „searchFields“ ignoriert, da NLS-Suchen nur im Feld „Problem“ durchgeführt werden können.
categoryPath	Zeichenfolge	Grenzt die Suchergebnisse auf ein oder mehrere bestimmte Kategorien ein. Es müssen der vollständige ID-Pfad zur Kategorie angegeben und mehrere Kategorien durch Kommas getrennt werden. Beispielsweise wird mit 1-3-5, 1-4-8 die Suche auf die Kategorien 5 und 8 (sowie deren Unterkategorien) eingegrenzt.
whereClause	Zeichenfolge	Verwenden Sie dies, um eine eigene SQL-Where-Klausel zum Filtern der Suchergebnisse hinzuzufügen.
maxDocIds	Ganzzahl	Gibt die für die Rückgabe maximal zulässige Anzahl von Dokument-IDs an. Wenn beispielsweise für „resultSize“ der Wert 10 und für „maxDocIds“ der Wert 50 festgelegt wird und 100 übereinstimmende Dokumente in der Datenbank vorhanden sind, dann werden für 10 von ihnen detaillierte Informationen abgefragt, und für weitere 40 lediglich die IDs zurückgegeben. Die übrigen 50 werden nicht zurückgegeben. Der Standardwert ist 100.

Beschreibung

Sucht Lösungen für ein Problem. Dokumente werden auf Grundlage des übergebenen Problems abgerufen. Es werden alle Dokumente zurückgegeben, die mit der Beschreibung des Problems oder einer ähnlichen Beschreibung übereinstimmen. Zur Leistungsverbesserung werden mit diesen Methoden nur detaillierte Informationen über einen benutzerdefinierten Satz von Dokumenten abgerufen, was anhand des Parameters „resultSize“ gesteuert wird. Für die verbleibenden Dokumente werden lediglich die IDs zurückgegeben. Mit dieser Methode können Sie beispielsweise einen Seitennavigationsmechanismus einrichten, bei dem Benutzer auf Verknüpfungen wie „Seitenanfang“, „Zurück“, „Vorwärts“ und „Seitenende“ klicken können. Wenn der nächste Informationssatz abgerufen werden soll, können Sie die Methode „getDocumentsByIDs()“ verwenden.

Rückgabe

Ein <UDSObjectList>-Knoten mit den folgenden Abschnitten:

Ein <UDSObject>-Knoten aus dem Abschnitt über die <UDSObject>-Knotenbeschreibung in diesem Kapitel. Es ist ein <UDSObject>-Knoten mit allen angegebenen Eigenschaften für die ersten n mit der Methode gefundenen Dokumente vorhanden, wobei n dem Parameter „resultSize“ entspricht. Wenn beispielsweise der Parameter „resultSize“ den Wert 10 und der Parameter „maxDocIds“ den Wert 50 hat und die Methode 100 Dokumente findet, dann werden 10 <UDSObject>-Knoten mit allen angeforderten Attributen im <Attributes>-Abschnitt und 40 <UDSObject>-Knoten nur mit der ID-Eigenschaft im <Attributes>-Abschnitt angegeben. Sollen detaillierte <UDSObject>-Informationen für Dokumente mit den Nummern 11–20 abgerufen werden, muss die Methode „getDocumentsByIDs()“ aufgerufen und ihr diese IDs übergeben werden.

Wenn der Parameter „getRelatedCategories“ den Wert „True“ erhält, wird der <UDSObjectList>-Knoten in den <Attributes>-Abschnitt für zugehörige Kategorien eingeschlossen. Jeder <INDEX_DOC_LINKS>-Knoten enthält die relationale ID der Kategorie, wie im folgenden Beispiel dargestellt:

1-70