Skip to content
Qualia Docs

List a sealed page of explainable bad-data recommendations

POST
/v1/datasets/curation/suggestions
 
curl --request POST \
  --url https://example.com/v1/datasets/curation/suggestions \
  --header 'Content-Type: application/json' \
  --data '{ "analysis_id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "page_size": 100, "page_token": "example" }'

Parameters

Section titled “ Parameters ”

Query Parameters

Section titled “Query Parameters ”
account_id

Act on this account (active)

string | null format: uuid

Act on this account (active)

Header Parameters

Section titled “Header Parameters ”
x-api-key
string | null

Request Body required

Section titled “Request Body required ”
Media type application/json
ListDatasetCurationSuggestionsBody
object
analysis_id
required
string format: uuid
page_size
integer
default: 100 >= 1 <= 500
page_token
string | null
>= 2 characters <= 512 characters /^[0-9a-f]+$/

Responses

Section titled “ Responses ”

200

Section titled “200 ”

Successful Response

Media type application/json
DatasetCurationSuggestionPageModel
object
analysis
required
DatasetCurationAnalysisModel
object
analysis_id
required
string format: uuid
base_version_ids
required
Array<string>
>= 1 items <= 32 items
engine_revision
required
string
>= 1 characters <= 128 characters
status
required
string
Allowed values: queued running ready failed
phase
required
string
Allowed values: pass1 pass2 ready failed
base_member_count
required
integer
> 0 <= 18446744073709552000
processed_member_count
required
integer
<= 18446744073709552000
recommended_exclusion_count
required
integer
<= 18446744073709552000
threshold_digest
string | null
/^[0-9a-f]{64}$/
evidence_digest
string | null
/^[0-9a-f]{64}$/
recommendation_digest
string | null
/^[0-9a-f]{64}$/
selection_digest
string | null
/^[0-9a-f]{64}$/
audit_repo_id
string | null format: uuid
expected
object
generation
required
integer
> 0
git_hash_algorithm
required
string
Allowed values: sha1 sha256
git_oid
required
string
/^[0-9a-f]+$/
commit_id
required
string format: uuid
pack_digest
required
string
/^[0-9a-f]{64}$/
failure_code
string | null
>= 1 characters <= 128 characters
failure_detail
string | null
>= 1 characters <= 65536 characters
suggestions
required
Array<object>
<= 500 items
DatasetCurationSuggestionModel
object
episode_revision_id
required
string
/^[0-9a-f]{64}$/
episode_id
required
string format: uuid
dataset_id
required
string format: uuid
episode_index
required
integer
<= 2147483647
risk_score
required
integer
<= 100
reasons
required
Array<object>
>= 1 items <= 32 items
DatasetCurationReasonModel
object
code
required
string
/^[a-z0-9][a-z0-9_.-]{0,127}$/
evidence
required
object
key
additional properties
any
next_page_token
string | null
>= 2 characters <= 512 characters /^[0-9a-f]+$/
Example 
{
  "analysis": {
    "status": "queued",
    "phase": "pass1",
    "expected": {
      "git_hash_algorithm": "sha1"
    }
  }
}

422

Section titled “422 ”

Validation Error

Media type application/json
HTTPValidationError
object
detail
Array<object>
ValidationError
object
loc
required
Location
Array<string | integer>
msg
required
Message
string
type
required
Error Type
string
input
ctx
Context
object
Example generated
{
  "detail": [
    {
      "loc": [
        "example"
      ],
      "msg": "example",
      "type": "example",
      "input": "example",
      "ctx": {}
    }
  ]
}