autocomplete-suggest

構文

suggestions nodeset autocomplete-suggest(dictionary, str, num, rights, filter, bag-of-words);
string dictionary;
string str;
int num;
string rights;
string filter;
boolean bag-of-words;

パラメーター

• string dictionary - オートコンプリート・データ・ストアを作成した辞書の名前。(必須)
• string str - オートコンプリートする入力ストリング。(必須)
• int num - 返される候補の数。デフォルト値: 10
• string rights - 候補で考慮すべき権限の改行区切りのリスト。
• string filter - 返される候補に適用されるフィルターが入ったノード。
• boolean bag-of-words - この設定を有効にする場合、用語の順序が正しくない場合でも解答は一致します。デフォルト値: false。

戻り値

• suggestions nodeset

例外

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

認証

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

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

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

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

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

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