recherche

Méthodes de services Web › Gestion des connaissances › Méthodes générales des Gestion des connaissances › recherche

recherche

Les paramètres suivants s’appliquent à la méthode search :

Paramètre	Type	Description
SID	Nombre entier	Identifie la session extraite depuis la connexion.
problème	Chaîne	Identifie la description du problème que vous souhaitez résoudre.
resultSize	Nombre entier	Identifie le nombre de documents pour lesquels vous souhaitez extraire des informations détaillées. Seul l’ID des documents restants est renvoyé. Vous pouvez accéder ultérieurement à ces informations détaillées à l’aide de la méthode getDocumentsByIDs(). La valeur par défaut est 10.
propertyList	Chaîne	Identifie la liste de données séparées par des virgules des champs de la base de données dont vous souhaitez extraire des informations. Les champs suivants sont toujours renvoyés, quel que soit le paramètre propertyList : id DOC_TYPE_ID
sortBy	Chaîne	Identifie le champ de la base de données que vous souhaitez utiliser pour trier les résultats. Les champs à tri multiple ne sont pas pris en charge. La valeur par défaut est RELEVANCE. Lorsque l'identificateur est un tri secondaire, il trie toujours les résultats. Pour connaître les propriétés de tri valables, reportez-vous à la méthode faq.
descending	Booléen	Identifie un indicateur permettant de trier les résultats par ordre décroissant.
relatedCategories	Booléen	Renvoie une liste de toutes les catégories associées pour le document trouvé.
searchType	Nombre entier	Type de recherche à effectuer : 1 = Natural Language Search (NLS) 2= Gestion des connaissances search
matchType	Nombre entier	Représente le type de correspondance : 0 = Type de correspondance OU 1 = Type de correspondance ET 2 = Correspondance exacte Remarque : Si NLS est sélectionné pour le paramètre searchType, alors seuls les matchTypes OU et ET sont valides.
searchField	Nombre entier	Représente la combinaison binaire de champs dans lesquels la recherche est effectuée : Titre = 1 Résumé = 2 Problème = 4 Résolution = 8 Par exemple, pour lancer la recherche dans tous les champs, indiquez 15 (1+2+4+8). Pour lancer la recherche uniquement dans Résumé et Problème, indiquez 6 (2+4). Remarque : La recherche par défaut porte sur Problème. Si vous définissez le paramètre searchType sur NLS, le paramètre searchFields est ignoré, car ce type de recherche porte uniquement sur le champ Problème.
categoryPath	Chaîne	Limite les résultats de la recherche à une ou plusieurs catégories spécifiques. Vous devez indiquer le chemin d’ID complet de la catégorie et séparer les catégories par des virgules. Par exemple, indiquez 1-3-5, 1-4-8 pour limiter la recherche aux catégories 5 et 8 (et à leurs sous-catégories).
whereClause	Chaîne	Utilisez ce paramètre pour ajouter votre propre clause SQL Where et filtrer les résultats de la recherche.
maxDocIds	Nombre entier	Représente le nombre maximum d’ID de document à renvoyer. Par exemple, si vous définissez resultSize sur 10 et maxDocIds sur 50, s’il existe 100 documents correspondants dans la base de données, les informations détaillées de 10 de ces documents sont extraites, et les ID de 40 de ces documents sont renvoyés. Les 50 résultats restants ne sont pas renvoyés. La valeur par défaut est 100.

Description

Recherche les solutions à un problème. Les documents sont extraits en fonction du problème transmis. Tous les documents correspondant à la description du problème ou à une description similaire sont renvoyés. Pour une performance optimale, ces méthodes extraient uniquement les informations détaillées d’un ensemble de documents défini par l’utilisateur et contrôlé via le paramètre resultSize. Les autres documents renvoient uniquement leur ID. Cette méthode permet, par exemple, de configurer une méthode de pagination qui met des liens Haut, Précédente, Suivante et Bas à la disposition de l’utilisateur. Pour extraire les informations suivantes, vous pouvez utiliser la méthode getDocumentsByIDs().

Eléments renvoyés

Un nœud <UDSObjectList> avec les sections suivantes :

Le nœud <UDSObject> de la section Description du nœud <UDSObject> du présent chapitre. Il existe un nœud <UDSObject> contenant toutes les propriétés des n premiers documents que la méthode trouve lorsque n est égal au paramètre resultSize. Par exemple, si le paramètre resultSize est défini sur 10, le paramètre maxDocIds sur 50 et que la méthode trouve 100 documents, il existe alors 10 noeuds <UDSObject> ayant toutes les propriétés requises dans la section <Attributes> et 40 <UDSObject> avec la propriété d'ID dans la section <Attributes>. Si vous souhaitez extraire des informations détaillées sur <UDSObject> pour les documents numérotés de 11 à 20, vous devez appeler la méthode getDocumentsByIDs() et lui transmettre ces ID.

Si le paramètre getRelatedCategories est défini sur Vrai, le nœud <UDSObjectList> est inclus dans la section <Attributes> des catégories associées. Chaque noeud <INDEX_DOC_LINKS> contient l'ID relationnel de la catégorie, comme indiqué dans l'exemple suivant :

1-70