query-browse

構文

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;

パラメーター

• string file - キャッシュに入れられている結果を格納している一時ファイルを参照します。 (必須)
• string state - 検索出力で指定されている参照状態。デフォルト値: root|root。
• int browse-num - 最初はこの数の結果のみが返されます。state の指定を上書きします。
• int browse-start - 取得された数の結果のうち、ランクが browse-start よりも高い結果のみを返します (0 で始まります)。state の指定を上書きします。
• string output-bold-contents - 照会語およびクラスター・ラベルを太字にする (あるいは、output-bold-contents-except の値に基づいて太字にしない) コンテンツ名のスペース区切りリスト。
• boolean output-bold-contents-except - true に設定する場合、コンテンツのリストは、太字にしないコンテンツのリストとして見なされます。デフォルト値: false。
• string output-bold-class-root - 指定されない場合、太字化に標準の <b> タグが使用されます。指定される場合、各キーワードに対応する数値と連結されたこのルートを使用して、<span> タグがクラス名と共に使用されます。
• string output-bold-cluster-class-root - 指定されない場合、クラスター・ラベルの太字化に標準の <b> タグが使用されます。指定される場合、各クラスター・ラベルに対応する数値と連結されたこのルートを使用して、<span> タグがクラス名と共に使用されます。
• boolean output-query-node - 検索の実行に使用された照会ノードを返します。これは、パラメーターとして指定された照会ノードとは異なる場合があります。デフォルト値: true。
• enum output-display-mode - 「limited」モードを使用する場合、「normal」モードで返される XML データのサブセットが返されます。このサブセットは、API を使用して大容量のデータ・セットを返すアプリケーション向けに最適化されています。デフォルト値: default。指定可能な値: default|limited。

戻り値

• query-results nodeset

例外

• この関数に固有の例外はありません。

認証

ping を除くすべての Watson™ Explorer Engine API 関数と同様に、query-browse 関数には認証が必要です。

REST を使用する場合、HTTP または HTTPS を介して単に v.username および v.password を CGI パラメーターとして渡し、query-browse 関数への REST 呼び出しを認証することができます。

SOAP API を使用する場合、エンドポイントで資格情報をパラメーターとして渡すか、すべての Watson Explorer Engine 関数でサポートされている認証方式を活用することができます。いずれも、関数の実行に使用されるユーザー名とパスワードを指定するために認証オブジェクトに渡すことができる setAuthentication メソッドを提供します。query-browse 関数への SOAP 呼び出しを Java で実行する例は次のとおりです。

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

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

通常、個々のアプリケーション全体で 1 つの認証オブジェクトが再使用されます。