ebook img

Amazon Mechanical Turk - API Reference PDF

179 Pages·2017·1.28 MB·English
Save to my drive
Quick download
Download
Most books are stored in the elastic cloud where traffic is expensive. For this reason, we have a limit on daily download.

Preview Amazon Mechanical Turk - API Reference

Amazon Mechanical Turk API Reference API Version 2017-01-17 Amazon Mechanical Turk API Reference Amazon Mechanical Turk: API Reference Copyright © 2022 Amazon Web Services, Inc. and/or its affiliates. All rights reserved. Amazon's trademarks and trade dress may not be used in connection with any product or service that is not Amazon's, in any manner that is likely to cause confusion among customers, or in any manner that disparages or discredits Amazon. All other trademarks not owned by Amazon are the property of their respective owners, who may or may not be affiliated with, connected to, or sponsored by Amazon. Amazon Mechanical Turk API Reference Table of Contents Amazon Mechanical Turk API Reference ................................................................................................. 1 Operations........................................................................................................................................ 2 AcceptQualificationRequest......................................................................................................... 4 Description........................................................................................................................ 4 Request Syntax.................................................................................................................. 4 Request Parameters............................................................................................................ 4 Response Elements............................................................................................................. 4 Example............................................................................................................................ 4 ApproveAssignment.................................................................................................................... 6 Description........................................................................................................................ 6 Request Syntax.................................................................................................................. 6 Request Parameters............................................................................................................ 6 Response Elements............................................................................................................. 7 Example............................................................................................................................ 7 AssociateQualificationWithWorker................................................................................................ 8 Description........................................................................................................................ 8 Request Syntax.................................................................................................................. 8 Request Parameters............................................................................................................ 8 Response Elements............................................................................................................. 9 Example............................................................................................................................ 9 CreateAdditionalAssignmentsForHIT............................................................................................ 10 Description...................................................................................................................... 10 Request Syntax................................................................................................................ 10 Request Parameters.......................................................................................................... 10 Response Elements........................................................................................................... 11 Example.......................................................................................................................... 11 CreateHIT................................................................................................................................ 12 Description...................................................................................................................... 12 Request Syntax................................................................................................................ 12 Request Parameters.......................................................................................................... 13 Response Elements........................................................................................................... 15 Example.......................................................................................................................... 15 CreateHITType......................................................................................................................... 17 Description...................................................................................................................... 17 Request Syntax................................................................................................................ 17 Request Parameters.......................................................................................................... 17 Response Elements........................................................................................................... 18 Example.......................................................................................................................... 18 CreateHITWithHITType.............................................................................................................. 20 Description...................................................................................................................... 20 Request Syntax................................................................................................................ 20 Request Parameters.......................................................................................................... 20 Response Elements........................................................................................................... 22 Example.......................................................................................................................... 22 CreateQualificationType............................................................................................................ 24 Description...................................................................................................................... 24 Request Syntax................................................................................................................ 24 Request Parameters.......................................................................................................... 24 Response Elements........................................................................................................... 26 Example.......................................................................................................................... 26 CreateWorkerBlock................................................................................................................... 28 Description...................................................................................................................... 28 Request Syntax................................................................................................................ 28 Request Parameters.......................................................................................................... 28 API Version 2017-01-17 iii Amazon Mechanical Turk API Reference Response Elements........................................................................................................... 28 DeleteHIT................................................................................................................................ 29 Description...................................................................................................................... 29 Request Syntax................................................................................................................ 29 Request Parameters.......................................................................................................... 29 Response Elements........................................................................................................... 29 Example.......................................................................................................................... 29 DeleteQualificationType............................................................................................................ 31 Description...................................................................................................................... 31 Request Syntax................................................................................................................ 31 Request Parameters.......................................................................................................... 31 Response Elements........................................................................................................... 31 Example.......................................................................................................................... 31 DeleteWorkerBlock................................................................................................................... 33 Description...................................................................................................................... 33 Request Syntax................................................................................................................ 33 Request Parameters.......................................................................................................... 33 Response Elements........................................................................................................... 33 DisassociateQualificationFromWorker.......................................................................................... 34 Description...................................................................................................................... 34 Request Syntax................................................................................................................ 34 Request Parameters.......................................................................................................... 34 Response Elements........................................................................................................... 34 Example.......................................................................................................................... 34 GetAccountBalance................................................................................................................... 36 Description...................................................................................................................... 36 Request Syntax................................................................................................................ 36 Request Parameters.......................................................................................................... 36 Response Elements........................................................................................................... 36 Example.......................................................................................................................... 36 GetAssignment......................................................................................................................... 37 Description...................................................................................................................... 37 Request Syntax................................................................................................................ 37 Request Parameters.......................................................................................................... 37 Response Elements........................................................................................................... 37 GetFileUploadURL.................................................................................................................... 38 Description...................................................................................................................... 38 Request Syntax................................................................................................................ 38 Request Parameters.......................................................................................................... 38 Response Elements........................................................................................................... 38 GetHIT.................................................................................................................................... 39 Description...................................................................................................................... 39 Request Syntax................................................................................................................ 39 Request Parameters.......................................................................................................... 39 Response Elements........................................................................................................... 39 GetQualificationScore............................................................................................................... 40 Description...................................................................................................................... 40 Request Syntax................................................................................................................ 40 Request Parameters.......................................................................................................... 40 Response Elements........................................................................................................... 40 Example.......................................................................................................................... 40 GetQualificationType................................................................................................................ 42 Description...................................................................................................................... 42 Request Syntax................................................................................................................ 42 Request Parameters.......................................................................................................... 42 Response Elements........................................................................................................... 42 Example.......................................................................................................................... 42 API Version 2017-01-17 iv Amazon Mechanical Turk API Reference ListAssignmentsForHIT.............................................................................................................. 44 Description...................................................................................................................... 44 Request Syntax................................................................................................................ 44 Request Parameters.......................................................................................................... 44 Response Elements........................................................................................................... 45 Example.......................................................................................................................... 45 ListBonusPayments................................................................................................................... 46 Description...................................................................................................................... 46 Request Syntax................................................................................................................ 46 Request Parameters.......................................................................................................... 46 Response Elements........................................................................................................... 46 Example.......................................................................................................................... 47 ListHITs................................................................................................................................... 48 Description...................................................................................................................... 48 Request Syntax................................................................................................................ 48 Request Parameters.......................................................................................................... 48 Response Elements........................................................................................................... 48 Example.......................................................................................................................... 48 ListHITsForQualificationType...................................................................................................... 50 Description...................................................................................................................... 50 Request Syntax................................................................................................................ 50 Request Parameters.......................................................................................................... 50 Response Elements........................................................................................................... 50 Example.......................................................................................................................... 50 ListQualificationRequests........................................................................................................... 52 Description...................................................................................................................... 52 Request Syntax................................................................................................................ 52 Request Parameters.......................................................................................................... 52 Response Elements........................................................................................................... 52 Example.......................................................................................................................... 52 ListQualificationTypes............................................................................................................... 54 Description...................................................................................................................... 54 Request Syntax................................................................................................................ 54 Request Parameters.......................................................................................................... 54 Response Elements........................................................................................................... 55 Example.......................................................................................................................... 55 ListReviewableHITs................................................................................................................... 56 Description...................................................................................................................... 56 Request Syntax................................................................................................................ 56 Request Parameters.......................................................................................................... 56 Response Elements........................................................................................................... 57 Example.......................................................................................................................... 57 ListReviewPolicyResultsForHIT.................................................................................................... 58 Description...................................................................................................................... 58 Request Syntax................................................................................................................ 58 Request Parameters.......................................................................................................... 58 Response Elements........................................................................................................... 59 ListWorkerBlocks...................................................................................................................... 60 Description...................................................................................................................... 60 Request Syntax................................................................................................................ 60 Request Parameters.......................................................................................................... 60 Response Elements........................................................................................................... 60 Example.......................................................................................................................... 60 ListWorkersWithQualificationType............................................................................................... 62 Description...................................................................................................................... 62 Request Syntax................................................................................................................ 62 Request Parameters.......................................................................................................... 62 API Version 2017-01-17 v Amazon Mechanical Turk API Reference Response Elements........................................................................................................... 62 Example.......................................................................................................................... 62 NotifyWorkers.......................................................................................................................... 64 Description...................................................................................................................... 64 Request Syntax................................................................................................................ 64 Request Parameters.......................................................................................................... 64 Response Elements........................................................................................................... 64 RejectAssignment..................................................................................................................... 65 Description...................................................................................................................... 65 Request Syntax................................................................................................................ 65 Request Parameters.......................................................................................................... 65 Response Elements........................................................................................................... 65 Example.......................................................................................................................... 66 RejectQualificationRequest........................................................................................................ 67 Description...................................................................................................................... 67 Request Syntax................................................................................................................ 67 Request Parameters.......................................................................................................... 67 Response Elements........................................................................................................... 67 Example.......................................................................................................................... 67 SendBonus.............................................................................................................................. 69 Description...................................................................................................................... 69 Request Syntax................................................................................................................ 69 Request Parameters.......................................................................................................... 69 Response Elements........................................................................................................... 70 SendTestEventNotification......................................................................................................... 71 Description...................................................................................................................... 71 Request Syntax................................................................................................................ 71 Request Parameters.......................................................................................................... 71 Response Elements........................................................................................................... 71 UpdateExpirationForHIT............................................................................................................ 72 Description...................................................................................................................... 72 Request Syntax................................................................................................................ 72 Request Parameters.......................................................................................................... 72 Response Elements........................................................................................................... 72 UpdateHITReviewStatus............................................................................................................ 73 Description...................................................................................................................... 73 Request Syntax................................................................................................................ 73 Request Parameters.......................................................................................................... 73 Response Elements........................................................................................................... 73 UpdateHITTypeOfHIT................................................................................................................ 74 Description...................................................................................................................... 74 Request Syntax................................................................................................................ 74 Request Parameters.......................................................................................................... 74 Response Elements........................................................................................................... 74 UpdateNotificationSettings........................................................................................................ 75 Description...................................................................................................................... 75 Request Syntax................................................................................................................ 75 Request Parameters.......................................................................................................... 75 Response Elements........................................................................................................... 76 UpdateQualificationType........................................................................................................... 77 Description...................................................................................................................... 77 Request Syntax................................................................................................................ 77 Request Parameters.......................................................................................................... 77 Response Elements........................................................................................................... 79 Example.......................................................................................................................... 79 Question and Answer Data ................................................................................................................ 81 Crowd HTML Elements .............................................................................................................. 82 API Version 2017-01-17 vi Amazon Mechanical Turk API Reference Description...................................................................................................................... 82 Use Cases........................................................................................................................ 82 Examples......................................................................................................................... 82 Element Reference........................................................................................................... 84 Related Documents.......................................................................................................... 84 Using XML Parameter Values ..................................................................................................... 85 XML Data as a Parameter .................................................................................................. 85 Namespaces for XML Parameter Values ............................................................................... 85 HITLayout................................................................................................................................ 86 Description...................................................................................................................... 86 Obtaining a Layout ID ....................................................................................................... 86 Using a HITLayout ............................................................................................................ 86 Guidelines for Using HITLayouts ......................................................................................... 87 HTMLQuestion......................................................................................................................... 88 Description...................................................................................................................... 88 The HTMLQuestion Data Structure ..................................................................................... 89 Example.......................................................................................................................... 89 Using Crowd HTML Elements ............................................................................................. 90 Preview Mode.................................................................................................................. 91 The Form Action .............................................................................................................. 91 The Answer Data .............................................................................................................. 91 Guidelines For Using HTML Questions ................................................................................. 91 ExternalQuestion...................................................................................................................... 92 Description...................................................................................................................... 92 The ExternalQuestion Data Structure .................................................................................. 92 Example.......................................................................................................................... 93 The External Form ............................................................................................................ 93 Using Crowd HTML Elements ............................................................................................. 95 The Answer Data .............................................................................................................. 96 Guidelines For Using External Questions ............................................................................. 96 QuestionForm.......................................................................................................................... 97 Description...................................................................................................................... 97 QuestionForm Structure.................................................................................................... 98 Content Structure............................................................................................................. 99 Answer Specification....................................................................................................... 104 Example........................................................................................................................ 111 QuestionFormAnswers............................................................................................................. 113 Description.................................................................................................................... 113 The Structure of Answers ................................................................................................ 113 Example........................................................................................................................ 114 Formatted Content: XHTML ..................................................................................................... 115 Using Formatted Content ................................................................................................ 116 Supported XHTML Tags ................................................................................................... 116 How XHTML Formatted Content Is Validated ...................................................................... 118 AnswerKey............................................................................................................................. 119 Description.................................................................................................................... 119 The Structure of an Answer Key ....................................................................................... 120 Example........................................................................................................................ 121 Data Structure Schema Locations ............................................................................................. 122 Data Structures.............................................................................................................................. 123 Assignment............................................................................................................................ 123 Description.................................................................................................................... 123 Elements....................................................................................................................... 123 Example........................................................................................................................ 126 HIT....................................................................................................................................... 127 Description.................................................................................................................... 127 Elements....................................................................................................................... 127 API Version 2017-01-17 vii Amazon Mechanical Turk API Reference Example........................................................................................................................ 131 HITLayoutParameter............................................................................................................... 132 Description.................................................................................................................... 132 Elements....................................................................................................................... 132 Qualification.......................................................................................................................... 133 Description.................................................................................................................... 133 Elements....................................................................................................................... 133 Example........................................................................................................................ 134 QualificationRequest............................................................................................................... 135 Description.................................................................................................................... 135 Elements....................................................................................................................... 135 Example........................................................................................................................ 136 QualificationRequirement........................................................................................................ 137 Description.................................................................................................................... 137 Using Custom, System-Assigned, and Master Qualification Types .......................................... 137 Elements....................................................................................................................... 138 Qualification Type IDs ..................................................................................................... 141 Master Qualification........................................................................................................ 142 Adding Adult Content ..................................................................................................... 142 The Locale Qualification.................................................................................................. 143 Example—Using the QualificationRequirement Data Structure .............................................. 144 Example—Using the QualificationRequirement Data Structure for Comparing Multiple Values ... 144 Example—Using the QualificationRequirement Data Structure to Hide HIT from Unqualified Workers......................................................................................................................... 144 QualificationType.................................................................................................................... 145 Description.................................................................................................................... 145 Elements....................................................................................................................... 145 Example........................................................................................................................ 147 HIT Review Policy ................................................................................................................... 149 Description.................................................................................................................... 149 HIT Review Policy Elements ............................................................................................. 149 Parameter Elements........................................................................................................ 149 MapEntry Elements......................................................................................................... 150 Examples....................................................................................................................... 150 Locale................................................................................................................................... 152 Description.................................................................................................................... 152 Elements....................................................................................................................... 152 Example........................................................................................................................ 152 Example........................................................................................................................ 152 Review Policies............................................................................................................................... 154 How Review Policies Work ....................................................................................................... 154 Assignment Review Policies ..................................................................................................... 155 ScoreMyKnownAnswers/2011-09-01................................................................................. 155 HIT Review Policies ................................................................................................................. 157 SimplePlurality/2011-09-01............................................................................................. 157 Review Policy Use Cases .......................................................................................................... 161 Photo Moderation Use Case – Single Worker with Known Answers ........................................ 161 Photo Moderation Use Case – Multiple Workers with Agreement ........................................... 162 Categorization and Tagging Use Case – Multiple Workers ..................................................... 164 Managing Notifications.................................................................................................................... 166 Elements of a Notification Message.......................................................................................... 166 The Notification API Version ............................................................................................ 166 Events........................................................................................................................... 167 Notification Handling Using Amazon SQS .................................................................................. 167 Creating an SQS Queue ................................................................................................... 167 Configuring an SQS Queue .............................................................................................. 167 Amazon SQS Policy Document Example ............................................................................ 168 API Version 2017-01-17 viii Amazon Mechanical Turk API Reference Configuring Permissions Using the AWS Console ................................................................ 168 Configuring Permissions Using the Amazon SQS API ........................................................... 168 Testing Your Queue ........................................................................................................ 169 Guaranteed Delivery....................................................................................................... 169 SQS Message Ordering .................................................................................................... 169 Multiple SQS Queues ...................................................................................................... 169 SQS Message Payload ..................................................................................................... 169 Double Delivery.............................................................................................................. 170 Notification Handling Using Amazon SNS .................................................................................. 170 Creating an SNS Topic ..................................................................................................... 170 Configuring an SNS Topic ................................................................................................ 170 Amazon SNS Policy Document Example ............................................................................ 171 Configuring Permissions Using the AWS Console ................................................................ 171 Configuring Permissions Using the Amazon SNS API ........................................................... 171 Testing Your Topic .......................................................................................................... 172 SNS Message Payload ..................................................................................................... 172 Double Delivery.............................................................................................................. 172 Notification............................................................................................................................ 173 Description.................................................................................................................... 173 Elements....................................................................................................................... 173 Example........................................................................................................................ 174 API Version 2017-01-17 ix Amazon Mechanical Turk API Reference Amazon Mechanical Turk API Reference This is the Amazon Mechanical Turk API Reference. This guide provides detailed information about Amazon Mechanical Turk operations, data structures, and parameters. The major sections of this guide are described in the following table. Amazon Mechanical Turk is a web service that provides an on-demand, scalable, human workforce to complete jobs that humans can do better than computers, for example, recognizing objects in photos. For more information about this product go to the Amazon Mechanical Turk website. Important If you do not add a CORS configuration to the S3 buckets that contain your image input data, HITs that you create using those input images will fail. To learn more, see CORS Configuration Requirement. Operations (p. 2) Alphabetical list of all Amazon Mechanical Turk operations. Data Structure Schema Links to Amazon Mechanical Turk data structure schemas. Locations (p. 122) Question and Answer Data (p. 81) Description of question and answer data that Amazon Mechanical Turk passes between Requesters and Workers. Data Structures (p. 123) Alphabetical list of all Amazon Mechanical Turk data structures. Review Policies (p. 154) Description of Amazon Mechanical Turk Review Policies. Managing Notifications (p. 166) Description of how Amazon Mechanical Turk sends notification messages to your application. API Version 2017-01-17 1

Description:
Amazon Mechanical Turk API Reference. Master Qualification. Master Qualification. You can require that Workers must have a Master Qualification to complete your HITs. To create a Qualification requirement for Masters, specify: • A QualificationTypeId of 2F1QJWKUDD8XADTFD2Q0G6UTO95ALH.
See more

The list of books you might like

Most books are stored in the elastic cloud where traffic is expensive. For this reason, we have a limit on daily download.