ENTITY developer reference
ClassificationsResult
Candidate documentation for reading and synthetic examples. Account creation, live API access, SDKs, collections and MCP are not available here. A released service profile and matching integration instructions are required before use.
This is a documentation reading view of an unreleased candidate, not a downloadable replacement schema. Public wire names, types and constraints are retained except for the explicitly marked private-only subsets and route patterns. Private governance references are explained in public language. Use only a separately released, verified generation for clients. Read the explicit exclusions.
This is the public candidate schema reading view. Read it with the operation that uses it; a representable field does not establish enabled coverage or entitlement.
Confidence is scoped to the immutable permitted information profile, not page length or input matching; every returned business fact must be mapped.
Declared type: "object"
Declared fields
This list shows only properties declared directly in this schema. Required labels refer only to this schema’s own required array. Referenced, composed and conditional rules can add constraints; a field not listed as required here is not guaranteed to be optional.
subject
Listed in this schema’s required array.
- Declared type
- Not declared directly; consult the complete field definition.
Reading definition for subject
{
"$ref": "#/components/schemas/SubjectRef"
}assignments
Listed in this schema’s required array.
- Declared type
"array"
Reading definition for assignments
{
"type": "array",
"items": {
"$ref": "#/components/schemas/Classification"
},
"x-profile-maxItems": "page_size_max"
}page
Listed in this schema’s required array.
- Declared type
- Not declared directly; consult the complete field definition.
Reading definition for page
{
"$ref": "#/components/schemas/Page"
}data_state
Listed in this schema’s required array.
- Declared type
- Not declared directly; consult the complete field definition.
Reading definition for data_state
{
"$ref": "#/components/schemas/Availability"
}absence_evidence
Listed in this schema’s required array.
- Declared type
- Not declared directly; consult the complete field definition.
Reading definition for absence_evidence
{
"anyOf": [
{
"$ref": "#/components/schemas/EvidenceSummary"
},
{
"type": "null"
}
]
}confidence_summary
Listed in this schema’s required array.
- Declared type
- Not declared directly; consult the complete field definition.
Reading definition for confidence_summary
{
"$ref": "#/components/schemas/ConfidenceSummary"
}Schema reading view
Read all retained constraints, including any allOf, oneOf, anyOf, conditional and additional-property constraints. The field list does not combine branches. Explicitly marked private-only omissions mean this view is not an executable substitute for the original schema or a released contract.
{
"type": "object",
"properties": {
"subject": {
"$ref": "#/components/schemas/SubjectRef"
},
"assignments": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Classification"
},
"x-profile-maxItems": "page_size_max"
},
"page": {
"$ref": "#/components/schemas/Page"
},
"data_state": {
"$ref": "#/components/schemas/Availability"
},
"absence_evidence": {
"anyOf": [
{
"$ref": "#/components/schemas/EvidenceSummary"
},
{
"type": "null"
}
]
},
"confidence_summary": {
"$ref": "#/components/schemas/ConfidenceSummary"
}
},
"required": [
"subject",
"assignments",
"page",
"data_state",
"absence_evidence",
"confidence_summary"
],
"additionalProperties": false,
"allOf": [
{
"if": {
"properties": {
"data_state": {
"const": "available"
}
},
"required": [
"data_state"
]
},
"then": {
"anyOf": [
{
"properties": {
"assignments": {
"minItems": 1
}
}
},
{
"properties": {
"absence_evidence": {
"not": {
"type": "null"
}
}
}
}
]
},
"else": {
"properties": {
"assignments": {
"maxItems": 0
},
"absence_evidence": {
"type": "null"
}
}
}
}
],
"description": "Confidence is scoped to the immutable permitted information profile, not page length or input matching; every returned business fact must be mapped."
}