Self-Serve Tariff Code Classification

Version selfservicetarrifclassification
Certificates
Classification
Notes
Profile

ClassificationResponseInteraction

A classification interaction returned in a classification response. Interactions group together a question prompt, the available options (attrs), and metadata about how the question was answered or inferred.

Parameters
idOptional
string

Identifier of this interaction. Echo this value as 'interactionid' in a continue request to answer this specific question.

nameOptional
string

Localized display label of the question's category. Always equal to 'label' (both fields carry the same value, retained for backward compatibility). May include compositional context, for example "whole of the propeller" or "power source location of the power source". For TARIFF_SCHEDULE interactions this is the literal string "underspecified".

labelOptional
string

Localized display label of the question's category. Always equal to 'name' (both fields carry the same value, retained for backward compatibility).

categoryOptional
string

Canonical, untranslated machine-readable identifier of the question's category. Stable across response languages.

typeOptional
string

Wire-level interaction type. Determines how the caller should answer the question and how 'attrs[].value' / 'attrs[].number' should be interpreted.

Enum: SELECTION, VALUED, TARIFF_SCHEDULE
headingOptional
string

Single HS heading or subheading(4 or 6-digit code) associated with this interaction, if any. Empty string when the interaction is not tied to a specific heading.

attrsOptional
array

Available options (candidate answers) for this interaction. Each entry describes one option, including its identifier, display name, and current selection state.

headingsOptional
string

Comma-separated list of HS headings or subheadings that remain in scope for this interaction's solution space. Sorted ascending.

inputTypeOptional
string

Source of the answer for this interaction.

Enum: specified by user, inferred, assumed
selectedStringOptional
string

Display string of the currently-selected answer(s). For SELECTION interactions, this is the selected option's name. For VALUED interactions, this is a semicolon-separated list of "% " entries. Lazily computed from 'attrs' when not explicitly set.

unSelectedStringOptional
string

Display string for unselected options, with a language-specific negative prefix (for example, "not cotton; not wool"). Lazily computed from 'attrs' when not explicitly set; null until first computed.

selectedDefinitionOptional
string

Definition of the selected option, populated only for SELECTION interactions when the selected option has a definition. Empty otherwise.

ruleMismatchOptional
boolean

True when the answer chosen for this interaction conflicts with a profile rule that would otherwise apply.

hasOtherOptional
boolean

True when this interaction includes an explicit "other" / fallback option.

languageOptional
string

Response language as an ISO 639-1 code. Defaults to 'EN'.

semanticAmbiguityOptional
boolean

True when the question carries a known semantic ambiguity (for example, the product description matches multiple distinct concepts).

answerIsOtherOptional
boolean

True when the currently-selected option is the "other" / fallback option.

answeredWithRuleOptional
boolean