Copyright | (c) 2013-2023 Brendan Hay |
---|---|
License | Mozilla Public License, v. 2.0. |
Maintainer | Brendan Hay |
Stability | auto-generated |
Portability | non-portable (GHC extensions) |
Safe Haskell | Safe-Inferred |
Language | Haskell2010 |
Synopsis
- data HIT = HIT' {
- assignmentDurationInSeconds :: Maybe Integer
- autoApprovalDelayInSeconds :: Maybe Integer
- creationTime :: Maybe POSIX
- description :: Maybe Text
- expiration :: Maybe POSIX
- hITGroupId :: Maybe Text
- hITId :: Maybe Text
- hITLayoutId :: Maybe Text
- hITReviewStatus :: Maybe HITReviewStatus
- hITStatus :: Maybe HITStatus
- hITTypeId :: Maybe Text
- keywords :: Maybe Text
- maxAssignments :: Maybe Int
- numberOfAssignmentsAvailable :: Maybe Int
- numberOfAssignmentsCompleted :: Maybe Int
- numberOfAssignmentsPending :: Maybe Int
- qualificationRequirements :: Maybe [QualificationRequirement]
- question :: Maybe Text
- requesterAnnotation :: Maybe Text
- reward :: Maybe Text
- title :: Maybe Text
- newHIT :: HIT
- hit_assignmentDurationInSeconds :: Lens' HIT (Maybe Integer)
- hit_autoApprovalDelayInSeconds :: Lens' HIT (Maybe Integer)
- hit_creationTime :: Lens' HIT (Maybe UTCTime)
- hit_description :: Lens' HIT (Maybe Text)
- hit_expiration :: Lens' HIT (Maybe UTCTime)
- hit_hITGroupId :: Lens' HIT (Maybe Text)
- hit_hITId :: Lens' HIT (Maybe Text)
- hit_hITLayoutId :: Lens' HIT (Maybe Text)
- hit_hITReviewStatus :: Lens' HIT (Maybe HITReviewStatus)
- hit_hITStatus :: Lens' HIT (Maybe HITStatus)
- hit_hITTypeId :: Lens' HIT (Maybe Text)
- hit_keywords :: Lens' HIT (Maybe Text)
- hit_maxAssignments :: Lens' HIT (Maybe Int)
- hit_numberOfAssignmentsAvailable :: Lens' HIT (Maybe Int)
- hit_numberOfAssignmentsCompleted :: Lens' HIT (Maybe Int)
- hit_numberOfAssignmentsPending :: Lens' HIT (Maybe Int)
- hit_qualificationRequirements :: Lens' HIT (Maybe [QualificationRequirement])
- hit_question :: Lens' HIT (Maybe Text)
- hit_requesterAnnotation :: Lens' HIT (Maybe Text)
- hit_reward :: Lens' HIT (Maybe Text)
- hit_title :: Lens' HIT (Maybe Text)
Documentation
The HIT data structure represents a single HIT, including all the information necessary for a Worker to accept and complete the HIT.
See: newHIT
smart constructor.
HIT' | |
|
Instances
Create a value of HIT
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:assignmentDurationInSeconds:HIT'
, hit_assignmentDurationInSeconds
- The length of time, in seconds, that a Worker has to complete the HIT
after accepting it.
$sel:autoApprovalDelayInSeconds:HIT'
, hit_autoApprovalDelayInSeconds
- The amount of time, in seconds, after the Worker submits an assignment
for the HIT that the results are automatically approved by Amazon
Mechanical Turk. This is the amount of time the Requester has to reject
an assignment submitted by a Worker before the assignment is
auto-approved and the Worker is paid.
$sel:creationTime:HIT'
, hit_creationTime
- The date and time the HIT was created.
$sel:description:HIT'
, hit_description
- A general description of the HIT.
$sel:expiration:HIT'
, hit_expiration
- The date and time the HIT expires.
$sel:hITGroupId:HIT'
, hit_hITGroupId
- The ID of the HIT Group of this HIT.
$sel:hITId:HIT'
, hit_hITId
- A unique identifier for the HIT.
$sel:hITLayoutId:HIT'
, hit_hITLayoutId
- The ID of the HIT Layout of this HIT.
$sel:hITReviewStatus:HIT'
, hit_hITReviewStatus
- Indicates the review status of the HIT. Valid Values are NotReviewed |
MarkedForReview | ReviewedAppropriate | ReviewedInappropriate.
$sel:hITStatus:HIT'
, hit_hITStatus
- The status of the HIT and its assignments. Valid Values are Assignable |
Unassignable | Reviewable | Reviewing | Disposed.
$sel:hITTypeId:HIT'
, hit_hITTypeId
- The ID of the HIT type of this HIT
$sel:keywords:HIT'
, hit_keywords
- One or more words or phrases that describe the HIT, separated by commas.
Search terms similar to the keywords of a HIT are more likely to have
the HIT in the search results.
$sel:maxAssignments:HIT'
, hit_maxAssignments
- The number of times the HIT can be accepted and completed before the HIT
becomes unavailable.
$sel:numberOfAssignmentsAvailable:HIT'
, hit_numberOfAssignmentsAvailable
- The number of assignments for this HIT that are available for Workers to
accept.
$sel:numberOfAssignmentsCompleted:HIT'
, hit_numberOfAssignmentsCompleted
- The number of assignments for this HIT that have been approved or
rejected.
$sel:numberOfAssignmentsPending:HIT'
, hit_numberOfAssignmentsPending
- The number of assignments for this HIT that are being previewed or have
been accepted by Workers, but have not yet been submitted, returned, or
abandoned.
$sel:qualificationRequirements:HIT'
, hit_qualificationRequirements
- Conditions that a Worker's Qualifications must meet in order to accept
the HIT. A HIT can have between zero and ten Qualification requirements.
All requirements must be met in order for a Worker to accept the HIT.
Additionally, other actions can be restricted using the ActionsGuarded
field on each QualificationRequirement
structure.
$sel:question:HIT'
, hit_question
- The data the Worker completing the HIT uses produce the results. This is
either either a QuestionForm, HTMLQuestion or an ExternalQuestion data
structure.
$sel:requesterAnnotation:HIT'
, hit_requesterAnnotation
- An arbitrary data field the Requester who created the HIT can use. This
field is visible only to the creator of the HIT.
$sel:reward:HIT'
, hit_reward
- Undocumented member.
$sel:title:HIT'
, hit_title
- The title of the HIT.
hit_assignmentDurationInSeconds :: Lens' HIT (Maybe Integer) Source #
The length of time, in seconds, that a Worker has to complete the HIT after accepting it.
hit_autoApprovalDelayInSeconds :: Lens' HIT (Maybe Integer) Source #
The amount of time, in seconds, after the Worker submits an assignment for the HIT that the results are automatically approved by Amazon Mechanical Turk. This is the amount of time the Requester has to reject an assignment submitted by a Worker before the assignment is auto-approved and the Worker is paid.
hit_hITReviewStatus :: Lens' HIT (Maybe HITReviewStatus) Source #
Indicates the review status of the HIT. Valid Values are NotReviewed | MarkedForReview | ReviewedAppropriate | ReviewedInappropriate.
hit_hITStatus :: Lens' HIT (Maybe HITStatus) Source #
The status of the HIT and its assignments. Valid Values are Assignable | Unassignable | Reviewable | Reviewing | Disposed.
hit_keywords :: Lens' HIT (Maybe Text) Source #
One or more words or phrases that describe the HIT, separated by commas. Search terms similar to the keywords of a HIT are more likely to have the HIT in the search results.
hit_maxAssignments :: Lens' HIT (Maybe Int) Source #
The number of times the HIT can be accepted and completed before the HIT becomes unavailable.
hit_numberOfAssignmentsAvailable :: Lens' HIT (Maybe Int) Source #
The number of assignments for this HIT that are available for Workers to accept.
hit_numberOfAssignmentsCompleted :: Lens' HIT (Maybe Int) Source #
The number of assignments for this HIT that have been approved or rejected.
hit_numberOfAssignmentsPending :: Lens' HIT (Maybe Int) Source #
The number of assignments for this HIT that are being previewed or have been accepted by Workers, but have not yet been submitted, returned, or abandoned.
hit_qualificationRequirements :: Lens' HIT (Maybe [QualificationRequirement]) Source #
Conditions that a Worker's Qualifications must meet in order to accept
the HIT. A HIT can have between zero and ten Qualification requirements.
All requirements must be met in order for a Worker to accept the HIT.
Additionally, other actions can be restricted using the ActionsGuarded
field on each QualificationRequirement
structure.
hit_question :: Lens' HIT (Maybe Text) Source #
The data the Worker completing the HIT uses produce the results. This is either either a QuestionForm, HTMLQuestion or an ExternalQuestion data structure.