Methods

Query Parameters

• target.target_id

  string

  ID of the data set target (e.g. subscription ID, business application ID)

• target.target_type

  string

  type of the target

  Allowable values: [subscription,business_application,instance,data_mart]

• type

  string

  type of the data set

  Allowable values: [manual_labeling,payload_logging,feedback,business_payload,explanations,explanations_whatif,training,custom]

• managed_by

  string

  ID of the managing entity (e.g. business application ID)

• data_sets

  Always included*
  DataSetResponse[]

Status Code

• 200

  response

Custom Headers

• Content-Type

  string

  Allowable values: [application/json,text/csv,multipart/form-data]

Path Parameters

• data_set_id

  Required*

  string

  ID of the data set

  Possible values: 1 ≤ length ≤ 64, Value must match regular expression [a-z0-9_\-]+

  Example: 59e92703-febe-4eda-abfa-09261c48f3dd

Query Parameters

• header

  boolean

  if not provided service will attempt to automatically detect header in the first line

• skip

  integer

  skip number of rows from input

• limit

  integer

  limit for number of processed input rows

• delimiter

  string

  delimiter character for data provided as csv

• on_error

  string

  expected behaviour on error

  Allowable values: [stop,continue]

• csv_max_line_length

  number

  maximum length of single line in bytes (default 10MB)

[
  {
    "GENDER": "M",
    "PRODUCT_LINE": "Golf Equipment",
    "AGE": 25,
    "MARITAL_STATUS": "Unspecified",
    "PROFESSION": "Sales"
  },
  {
    "GENDER": "M",
    "PRODUCT_LINE": "Sport shoes",
    "AGE": 28,
    "MARITAL_STATUS": "Married",
    "PROFESSION": "Sales"
  },
  {
    "GENDER": "F",
    "PRODUCT_LINE": "Sport shoes",
    "AGE": 25,
    "MARITAL_STATUS": "Single",
    "PROFESSION": "Software Developer"
  }
]

[
  {
    "fields": [
      "GENDER",
      "PRODUCT_LINE",
      "AGE",
      "MARITAL_STATUS",
      "PROFESSION"
    ],
    "values": [
      [
        "M",
        "Golf Equipment",
        25,
        "Unspecified",
        "Sales"
      ],
      [
        "M",
        "Sport shoes",
        28,
        "Married",
        "Sales"
      ],
      [
        "F",
        "Sport shoes",
        25,
        "Single",
        "Software Developer"
      ]
    ]
  }
]

[
  {
    "response_time": 121,
    "request": {
      "fields": [
        "name",
        "age",
        "position"
      ],
      "values": [
        [
          "john",
          33,
          "engineer"
        ],
        [
          "mike",
          23,
          "student"
        ]
      ],
      "meta": {
        "fields": [
          "transactionid",
          "misc1"
        ],
        "values": [
          [
            "tran1345",
            "misc value for John"
          ],
          [
            "tran1345",
            "misc value for Mike"
          ]
        ]
      }
    },
    "response": {
      "fields": [
        "name",
        "age",
        "position",
        "prediction",
        "probability"
      ],
      "values": [
        [
          "john",
          33,
          "engineer",
          "personal",
          [
            0.6744664422398081,
            0.32553355776019194
          ]
        ],
        [
          "mike",
          23,
          "student",
          "camping",
          [
            0.2794765664946941,
            0.7205234335053059
          ]
        ]
      ]
    }
  }
]

• Fields and values of the entity matches JSON object's fields and values.

  One of

  Change Request Parameter List

  JsDictElem
  No properties to display

• state

  Always included*

  string

  Possible values: [preparing,active,deleting,pending_delete,disabled,error]

• deleted_at

  string

• failure

  GenericErrorResponse

Status Code

• 202

  response

Path Parameters

• data_set_id

  Required*

  string

  ID of the data set

  Possible values: 1 ≤ length ≤ 64, Value must match regular expression [a-z0-9_\-]+

  Example: 59e92703-febe-4eda-abfa-09261c48f3dd

Query Parameters

• start

  date-time

  return records with timestamp grather then or equal to start parameter

  Example: 2018-01-01T00:00:00Z

• end

  date-time

  return records with timestamp lower then end parameter

  Example: 2018-01-31T00:00:00Z

• limit

  integer

  limit for number of returned records. If the value is greater than 1000 than it will be truncated.

  Default: 100

• offset

  integer

  offset of returned records

• annotations

  string[]

  return record annotations with given names

  Examples:

  View

  [
    "annotation1",
    "annotation2"
  ]

  Copy to clipboard

• filter

  string

  Only return records that match given filters. There are two types of filters, separated by commas:

  • normal filter (multiple are possible), {field_name}:{op}:{value} — filter records directly
  • joining filter (only a single one is possible), {data_set_id}.{field_name}:{op}:{value} — join a data set by transaction_id (the user must ensure it's provided!) and filter by this data set's records' field. Will fail if the user hasn't provided transaction_id for both data sets' records. Filters of different types can be mixed. They are partly compatible with the ones in POST /v2/data_sets/{data_set_id}/distributions.

  Available operators: | op | meaning | example | code equivalent | |:----:|:---------------------------:|:------------------:|:------------------------:| | eq | equality | field:eq:value | field == value | | gt | greater than | field:gt:value | field > value | | gte | greater or equal | field:gte:value | field >= value | | lt | less than | field:lt:value | field < value | | lte | less or equal | field:lte:value | field <= value | | like | matching a simple pattern* | field:like:pattern | pattern.match(field) | | in | is contained in list | field:in:a;b;c | [a,b,c].contains(field) |

  • • "%" means "one or more character", "_" means "any single character", other characters have their usual, literal meaning (e.g. "|" means character "|")

  Examples:

  normal_filters

  Multiple normal filters

  age:gte:18,gender:eq:female

  Copy to clipboard

  joined_filter

  A single joined filter

  c06d3756-1f43-4ea1-9727-2085ae3ff21d.channel:eq:facebook

  Copy to clipboard

  mixed_filters

  A mix of normal filters and a joined filter

  age:ge:20,age:ls:30,c06d3756-1f43-4ea1-9727-2085ae3ff21d.channel:eq:facebook,age:gte:20,age:ls:30

  Copy to clipboard

• include_total_count

  boolean

  If total_count should be included. It can have performance impact if total_count is calculated.

• format

  string

  What JSON format to use on output.

  Allowable values: [dict,list]

  Default: dict

• binary_format

  string

  Binary data presentation format. By default, the binary field value is encoded to base64 string. If reference is chosen, every binary field is moved to the references section with value set to an uri to the particular field within the record that can be GET in a separate request.

  Allowable values: [reference]

• records

  Always included*
  DataRecordResponse[]

• total_count

  integer

  Number of all rows which satisfy the query. It is calculated and returned when include_total_count query param is set to true

Status Code

• 200

  response

• subscription_id

  Required*

  string

  Unique subscription ID.

  Example: c37c3c7c-67ae-48be-84bd-86cd2b25e618

• scoring_ids

  string[]

  IDs of the scoring transaction

  Examples:

  View

  [
    "scoring_id1",
    "scoring_id2"
  ]

  Copy to clipboard

• input_rows

  List of scoring transactions

  Examples:

  View

  [
    {
      "feature1": "value1",
      "probability": [
        0.4,
        0.6
      ],
      "prediction": "classA",
      "scoring_id": "scoring_id1",
      "subscription_id": "c37c3c7c-67ae-48be-84bd-86cd2b25e618",
      "service_provider_id": "c37c3c7c-67ae-48be-84bd-86cd2b25e619",
      "deployment_id": "c37c3c7c-67ae-48be-84bd-86cd2b25e620"
    }
  ]

  Copy to clipboard
  object[]
  input_rows

  any property

• explanation_types

  string[]

  Types of explanations to generate

  Allowable values: [lime,contrastive]

• metadata

  Always included*

  Metadata of post explanation tasks response

  PostExplanationTaskResponseMetadata

Status Code

• 202

  Explanation request submitted successfully

Path Parameters

• explanation_task_id

  Required*

  string

  ID of the explanation task

  Example: 9fdaa46c-c124-4700-b794-6d6a5262c3aa

Query Parameters

• subscription_id

  Required*

  string

  Unique subscription ID.

  Possible values: 1 ≤ length ≤ 64, Value must match regular expression [a-z0-9_\-]+

  Example: c37c3c7c-67ae-48be-84bd-86cd2b25e618

• metadata

  Always included*

  Metadata of get explanation task response

  GetExplanationTaskResponseMetadata

• entity

  Always included*

  Entity of get explanation task response

  GetExplanationTaskResponseEntity

Status Code

• 200

  Explanation successfully retrieved

Path Parameters

• subscription_id

  Required*

  string

  Unique subscription ID

  Possible values: 1 ≤ length ≤ 64, Value must match regular expression [a-z0-9_\-]+

  Example: c37c3c7c-67ae-48be-84bd-86cd2b25e618

• values

  Required*

  string[]

  The values associated to the fields

  Examples:

  View

  [
    [
      "john",
      33,
      "engineer"
    ]
  ]

  Copy to clipboard

• fields

  string[]

  The fields to process debias scoring

  Examples:

  View

  [
    "name",
    "age",
    "position"
  ]

  Copy to clipboard

• fields

  Always included*

  string[]

  The fields of the model processed debias scoring.

  Examples:

  View

  [
    "name",
    "age",
    "position",
    "prediction",
    "probability",
    "debiased_prediction",
    "debiased_probability",
    "debiased_decoded_target"
  ]

  Copy to clipboard

• values

  Always included*

  object[]

  The values associated to the fields.

  Examples:

  View

  [
    [
      "john",
      35,
      "engineer",
      0.3,
      [
        0.754601226993865,
        0.24539877300613497
      ],
      0.4,
      [
        0.754601226993865,
        0.24539877300613497
      ],
      "good"
    ]
  ]

  Copy to clipboard

Status Code

• 200

  Accepted