query-browse

Synopsis

query-results nodeset query-browse(file, 
state, browse-num, browse-start, output-bold-contents, 
output-bold-contents-except, output-bold-class-root, output-bold-cluster-class-root, 
output-query-node, output-display-mode);
string file;
string state;
int browse-num;
int browse-start;
string output-bold-contents;
boolean output-bold-contents-except;
string output-bold-class-root;
string output-bold-cluster-class-root;
boolean output-query-node;
enum output-display-mode;

Paramètres

• string file - Indique le fichier temporaire contenant les résultats mis en mémoire cache (obligatoire).
• string state - Indique l'état de la navigation, comme indiqué dans le résultat de la recherche. Valeur par défaut : root|root.
• int browse-num - Indique uniquement le nombre de résultats initialement renvoyés. Écrase toute valeur indiquée dans l'état.
• int browse-start - Sur le nombre de résultats extraits, renvoie uniquement ceux ayant un classement supérieur au paramètre browse-start (commence à 0). Écrase toute valeur indiquée dans l'état.
• string output-bold-contents - Liste des noms de contenu, séparés par des espaces, à mettre en gras (ou pas selon la valeur du paramètre output-bold-contents-except) avec les mots de la requête et les libellés de clusters.
• boolean output-bold-contents-except - Si ce paramètre est défini sur « true », la liste des contenus est considérée comme étant la liste des contenus à ne pas mettre en gras. Valeur par défaut : false.
• string output-bold-class-root - Si ce paramètre n'est pas spécifié, une balise <b> standard sera utilisée pour la mise en gras. Dans le cas contraire, une balise <span> sera associée à un nom de classe qui va utiliser cette racine concaténée avec un nombre correspondant à chaque mot-clé.
• string output-bold-cluster-class-root - Si ce paramètre n'est pas spécifié, une balise <b> standard sera utilisée pour la mise en gras des libellés de clusters. Dans le cas contraire, une balise <span> sera associée à un nom de classe qui va utiliser cette racine concaténée avec un nombre correspond à chaque libellé de cluster.
• boolean output-query-node - Renvoie le nœud de requête qui était utilisé pour effectuer des recherches. Ce nœud peut être différent du nœud de requête fourni en tant que paramètre. Valeur par défaut : true.
• enum output-display-mode - L'utilisation du mode « Limité » va renvoyer un sous-ensemble de données XML renvoyées en mode « Normal ». Ce sous-ensemble est optimisé pour les applications utilisant l'interface de programme d'application afin de renvoyer des jeux de données volumineux. Valeur par défaut : default. Valeurs possibles : default|limited.

Valeur de retour

• query-results nodeset

Exceptions

• Il n'existe aucune exception spécifique à cette fonction.

Authentification

Comme toutes les fonctions de l'API de Watson Explorer Engine, à l'exception de ping, la fonction query-browse requiert une authentification.

Lorsque vous utilisez l'interface REST, vous pouvez simplement transmettre v.username et v.password comme paramètres CGI via le protocole HTTP ou HTTPS afin d'authentifier l'appel REST pour la fonction query-browse.

Lorsque vous utilisez l'API SOAP, vous pouvez transmettre les données d'identification comme paramètres à un nœud final ou utiliser la méthode d'authentification prise en charge par toutes les fonctions de Watson Explorer Engine. Chacune fournit une méthode setAuthentication qui peut être transmise comme objet d'authentification afin de fournir le nom d'utilisateur et le mot de passe sous lesquels s'exécute une fonction. Par exemple, dans Java, pour adresser un appel SOAP à la fonction query-browse, la méthode d'authentification sera la suivante :

    Authentication authentication = new Authentication();
    authentication.setUsername("joe-user");
    authentication.setPassword("joes-password");

    QueryBrowse foo = new QueryBrowse();
    foo.setAuthentication(authentication);

Un objet d'authentification unique est généralement réutilisé dans chaque application individuelle.