annotation-user-set

構文

void annotation-user-set(collection, subcollection, content, 
document-vse-key, document-vse-key-normalized, username, acl, 
synchronization, priority, datesecs, weight);
nmtoken collection;
enum subcollection;
content nodeset content;
string document-vse-key;
boolean document-vse-key-normalized;
string username;
string acl;
enum synchronization;
int priority;
int datesecs;
int weight;

パラメーター

• nmtoken collection - アノテーションを追加する先の文書を保持するコレクションの名前。(必須)
• enum subcollection - エンキューする先のサブコレクション。デフォルト値: live。指定可能な値: live|staging。
• content nodeset content - 文書に追加される <content> ノード。少なくとも name 属性が必要です。空のノードを渡すと、このタグは「設定解除」されます。(必須)
• string document-vse-key - このコンテンツを追加する先の文書の VSE キー。(必須)
• boolean document-vse-key-normalized - 「true」に設定される場合、document-vse-key は、既に正規化されている場合と同様に処理され、追加の正規化は行われません。「false」に設定される場合、document-vse-key は正規化されます。デフォルト値: true。
• string username - このアノテーションが属するユーザーの名前。 (必須)
• string acl - 使用する ACL。(必須)
• enum synchronization - 使用する同期モード。デフォルト値: indexed。指定可能な値: enqueued|indexed|none|to-be-crawled|to-be-indexed|indexed-no-sync|none。
• int priority - 同時にクロールされる他の処理との関連におけるこのコンテンツのエンキューの優先順位。デフォルト値: 1
• int datesecs - アノテーションが実行済みとしてマークされる、エポック以降の日時 (秒)。設定されない場合、現在時刻が使用されます。バックアップ・ファイルからアノテーションをリストアする際に有用です。
• int weight - コンテンツに追加する重みづけの属性。ランキングに影響します。コンテンツの一致の重みづけが高いほど、重要度が高くなります。デフォルト値: 1

例外

• annotation-content-missing-name-attribute
• search-collection-invalid-name
• search-collection-enqueue

認証

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

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

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

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

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

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