Images class

We're going to explant about parameter for creation and example of use

Table of Content

Choice class

Description: Yes or No Question from Image (30 mins response time) - This model used for create select list on a moderator screen and let's they answer your question on what they're seeing. Answer can be only one or multiple choice

Create

params = { ..., token: '_token' }
Datawow.image_choice.create(params)

params

Field Type Required Description
instruction string Yes Tell moderator what answer you expected and what image is
categories Array[string] Yes List of answers that you were expected. sparate by use space
data string Yes URL of image
postback_url string No URL for answer callback once image has been checked
postback_method string No Configuration HTTP method GET POST PUT PATCH
allow_empty boolean No Allow answer can be blank. default is false
multiple boolean No Configuration for multiple selection of category to answer default is false
custom_id string No Custom ID that used for search

Closed Question class

Description: Standard Criteria (5 mins response time) - Answer can be only approved, declined or ban

Create

params = { ..., token: '_token' }
Datawow.image_closed_question.create(params)

params

Field Type Required Description
data string Yes URL of image
postback_url string No URL for answer callback once image has been checked
postback_method string No Configuration HTTP method GET POST PUT PATCH
custom_id string No Custom ID that used for search

Image messages class

Description: Message Question from Image (30 mins response time) - Allow a moderator to typing a answer on what they're seeing.

Create

params = { ..., token: '_token' }
Datawow.image_message.create(params)

params

Field Type Required Description
instruction string Yes Tell moderator what answer you expected and what image is
data string Yes URL of image
postback_url string No URL for answer callback once image has been checked
postback_method string No Configuration HTTP method GET POST PUT PATCH
custom_id string No Custom ID that used for search

Photo tags class

Description: Identifying an object in the image (60 mins response time) - This model is used for identifying the object within the hand drawn rectangle from the moderator, following any instructions given by the customer.

Create

>>> from datawow.images import PhotoTag as photo_tag
>>> result = photo_tag("PROJECT KEY").create(params=param)

params

Field Type Required Description
instruction string Yes Tell moderator what answer you expected and what image is
data string Yes URL of image
postback_url string No URL for answer callback once image has been checked
postback_method string No Configuration HTTP method GET POST PUT PATCH
custom_id string No Custom ID that used for search

Document Verification

Create

payload = {
  data: <document-image-url>,
  infos: {
    type: {
      value: <document-type> # - The document's type. e.g. "student card", "ID card", "Passport"
    },
    dob: {
      value: <customer-date-of-birth> # - The customer's date of birth. Should be in format like `YYYY-MM-DD`.
    }
  },
  postback_method: "GET", # - The HTTP method for posting result back to customer.
  postback_url: <customer-postback-url> # - The customer's endpoint url receives result after verified success.
}

Datawow.project_key = <project-token>
Datawow.document_verification.create(payload)

params

Field Type Required Description
data string Yes URL of image
infos Hash Yes Hash of document's informations
postback_url string No URL to receive result once document has been verified
postback_method string No Configuration HTTP method GET POST PUT PATCH
custom_id string No Custom ID that used for search 
Datawow.project_key = <project-token>
Datawow.document_verification.find_by(id: <either-id-or-custom_id>) # - To find task by specific ID.
# - To either retrieve task as a list or find by specific ID.
Datawow.document_verification.all(id: <either-id-or-custom_id>, page: <number-of-result-page>, per_page: <number-of-result-per-page>)

Common function

For every classes there are common functions to get list of data and find by ID. We're going to show you how to use it.

Query list of data by all()

params = { ..., token: '_token' }
Datawow.[model].all(params)

params

Field Type Required Description
page interger No default 0
per_page string No default 20

Find data with ID by find_by()

params = { id: '_id', token: '_token' }
Datawow.[model].find_by(params)

params

Field Type Required Description
id string Yes Image's ID or custom ID which is you were assigned