Node.js:
npm install @iflb/tutti-client
There are two ways to communicate with Tutti server: Call mode and Send mode.
Calling commands with await prefix, the process waits there until the response is sent back, and receives it as a return value.
const data = await client.<namespace>.<command>({ <args object> }, awaited = true);
OR equivalently,
const data = await client.<namespace>.<command>.call(<args object>);
Calling commands without await prefix, the process completes as soon as request is sent, and receives it in its listener.
Having defined a listener like below,
client.<namespace>.on('<command>', {
success: (data) => {
// do something for successful response...
},
error: (err) => {
// do something for errors...
},
complete: () => {
// do another thing to finalize request...
}
});
Run:
client.<namespace>.<command>({ <args object> }, awaited = false);
OR equivalently,
client.<namespace>.<command>.send(<args object>);
Node.js:
const { TuttiClient } = require('@iflb/tutti-client');
async function main() {
let client = new TuttiClient(true);
await client.open('http://localhost:8080/ducts/wsd');
// Sign in with an account first
await client.resource.signIn({ user_name: 'admin', password: 'admin' })
// Get a list of created projects
const projects = await client.resource.listProjects();
// List templates for the first project
const templates = await client.resource.listTemplates({ project_name: projects[0].name });
}
main();Browser:
<script src="https://unpkg.com/@iflb/tutti-client/dist/tutti.js"></script>
<script>
async function main() {
const client = new tutti.TuttiClient(true);
await client.open('http://localhost:8080/ducts/wsd');
// Sign in with an account first
await client.resource.signIn({ user_name: 'admin', password: 'admin' })
// Get a list of created projects
const projects = await client.resource.listProjects();
// List templates for the first project
const templates = await client.resource.listTemplates({ project_name: projects[0].name });
}
main();
</script>Current options for namespaces are: resource, mturk.
Checks whether the project is already rebuilt for the newest version.
project_name: String- Tutti project name.
- Boolean -- True if the project is in the newest version, thus no rebuild is needed.
name: String- Name for the nanotask group. Must be unique.
nanotask_ids: Arrayproject_name: String- Tutti project name.
template_name: String- Tutti template name of a project.
- String -- Created nanotask group ID.
project_name: String- Tutti project name.
template_name: String- Tutti template name of a project.
nanotasks: Arraytag: String- An arbitrary data field to tag nanotask for identifying purposes.
priority: Number- An integer value to represent nanotask importance. The smaller the value is, more prioritized the nanotask is among others. To learn more about nanotask priority, see Tutti's Programming Reference > Project Scheme.
num_assignable: Number- Maximum number of workers that can be assigned to nanotask.
- Object
project_name: String- Tutti project name.
template_name: String- Tutti template name of a project.
nanotask_ids: Array
project_name: String- Tutti project name.
project_name: String- Tutti project name.
template_name: String- Tutti template name of a project.
preset_group_name: Stringpreset_name: String
user_id: String- User ID of Tutti account.
nanotask_group_id: String
nanotask_ids: Array
project_name: String- Tutti project name.
project_name: String- Tutti project name.
template_name: String- Tutti template name of a project.
nanotask_group_id: String
project_name: String- Tutti project name.
cached: Boolean- Whether to return cached value in the response. Note that setting this value to false may result in slower responses.
- [None]
- [None]
project_name: String- Tutti project name.
template_name: String- Tutti template name of a project.
project_name: String- Tutti project name.
template_name: String- Tutti template name of a project.
project_name: String- Tutti project name.
template_name: String- Tutti template name of a project.
work_session_id: Stringonly_template: Boolean- If True, returns only node sessions for template nodes.
- [None]
- [None]
nanotask_id: String
project_name: String- Tutti project name.
project_name: String- Tutti project name.
template_name: String- Tutti template name of a project.
work_session_id: String
worker_id: String- Tutti's internal hash ID for worker.
project_name: String- Tutti project name.
project_name: String- Tutti project name.
project_name: String- Tutti project name.
project_name: String- Tutti project name.
project_name: String- Tutti project name.
project_name: String- Tutti project name.
project_name: String- Tutti project name.
user_name: String, default null- User name of Tutti account.
password_hash: String, default null- MD5-hashed password (hex-digested) of Tutti account.
access_token: String, default null- Valid access token obtained in previous logins.
...args:- Accepts only
passwordkey (non-hashed password of Tutti account). This is not recommended; usepassword_hashoraccess_tokeninstead.
- Accepts only
- [None]
user_name: String- User name of Tutti account.
password:privilege_ids: Array- Priviledge IDs to associate with account. Currently not in use.
access_key_id: String- Access Key ID of MTurk credentials.
secret_access_key: String- Secret Access Key of MTurk credentials.
label:
batch_id: String- Tutti's internal hash ID for Tutti HIT Batch.
hit_params: Object- Parameters for CreateHIT operation of MTurk.
num_hits: Number- Number of HITs to create for Tutti HIT Batch.
assignment_ids: Array- List of MTurk Assignment IDs.
requester_feedback:override_rejection:
qualification_type_id:worker_ids: Array- List of MTurk Worker IDs.
integer_value:send_notification:
name:description:auto_granted:qualification_type_status:
name:project_name: String- Tutti project name.
hit_type_params: Object- Parameters for CreateHITType operation of MTurk.
hit_params: Object- Parameters for CreateHIT operation of MTurk.
num_hits: Number- Number of HITs to create for Tutti HIT Batch.
credentials_id: String- Tutti's internal hash ID for registered MTurk credentials.
request_id: String- Arbitrary string value to identify response for this request.
hit_ids: Array- List of MTurk HIT Ids.
qualification_type_ids: Array- List of MTurk Qualification type IDs.
request_id: String- Arbitrary string value to identify response for this request.
batch_id: String- Tutti's internal hash ID for Tutti HIT Batch.
method:parameters:
request_id: String- Arbitrary string value to identify response for this request.
hit_ids: Array- List of MTurk HIT Ids.
- [None]
credentials_id: String- Tutti's internal hash ID for registered MTurk credentials.
batch_id: String- Tutti's internal hash ID for Tutti HIT Batch.
cached: Boolean- Whether to return cached value in the response. Note that setting this value to false may result in slower responses.
- [None]
- [None]
batch_id: String- Tutti's internal hash ID for Tutti HIT Batch.
cached: Boolean- Whether to return cached value in the response. Note that setting this value to false may result in slower responses.
query:only_user_defined: Boolean- Whether to filter out Qualification types of other requesters in the results. This is directly passed to MustBeOwnedByCaller parameter for MTurk's ListQualificationTypes operation.
cached: Boolean- Whether to return cached value in the response. Note that setting this value to false may result in slower responses.
- [None]
- [None]
- [None]
subject:message_text:worker_ids: Array- List of MTurk Worker IDs.
assignment_ids: Array- List of MTurk Assignment IDs.
requester_feedback:
credentials_id: String- Tutti's internal hash ID for registered MTurk credentials.
label:
worker_ids: Array- List of MTurk Worker IDs.
bonus_amount:assignment_ids: Array- List of MTurk Assignment IDs.
reason:
credentials_id: String- Tutti's internal hash ID for registered MTurk credentials.
is_sandbox: Boolean- Activation of Sandbox mode for MTurk credentials.