Glossary of inputs and responses
WoAG Occupation Coding Service User Guide
Model details, Record and Response objects.
Released
30/06/2025
These fields are returned by various methods in Gathering parameters:
Field | Description | Type |
---|---|---|
modelId | Unique identifier used to reference the ML model. | String (GUID format) |
modelVersion | Version number of the model trained on the topic. Distinct from topicVersion. | Number |
modelReleaseDate | Date the model was released, in ISO8601 format. | String |
modelType | ML algorithm used (e.g., hsvm). | String |
inputFormat | List of expected input field names. | Array of strings |
topicStandard | Full name of the classification topic. | String |
topicVersion | Version number of the topic classification used in model training. | String |
These are the fields expected when submitting data to the coding service:
Field | Description | Type |
---|---|---|
occp_text | Free-text description of an occupation. | String |
tasks_text | Tasks or duties related to the occupation. | String |
recordId | Optional identifier for each input record. | String |
Response objects
These are returned after synchronous or asynchronous coding operations:
Field | Description | Type |
---|---|---|
recordId | Identifier for the submitted input record (if originally provided). | String |
codeStatus | Coding outcome. Valid values: successful, unsuccessful. | String |
input | Input record submitted to the model. | RecordObject |
result | List of predicted codes and labels. Min length: 0; Max: 16 (or value of numberOfSuggestions) | Array of CodedRecord |
Field | Description | Type |
---|---|---|
recordId | Identifier for the record or empty string if none provided. | String |
result | Top code assigned if coding was successful. | CodedRecord object |
suggestions | List of alternate codes if coding was unsuccessful. Min length: 1; Max: 3 | Array of CodedRecord |
Field | Description | Type |
---|---|---|
codeCategory | Code assigned to the input. | String |
codeLabel | Description of the code category. | String |
codeConfidence | Confidence score (e.g., 0.92). May be rounded or multiplied by 100 for a percentage. |