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:

Model details
FieldDescriptionType
modelIdUnique identifier used to reference the ML model.String (GUID format)
modelVersionVersion number of the model trained on the topic. Distinct from topicVersion.Number
modelReleaseDateDate the model was released, in ISO8601 format.String
modelTypeML algorithm used (e.g., hsvm).String
inputFormatList of expected input field names.Array of strings
topicStandardFull name of the classification topic.String
topicVersionVersion number of the topic classification used in model training.String

These are the fields expected when submitting data to the coding service:

RecordObject
FieldDescriptionType
occp_textFree-text description of an occupation. String
tasks_textTasks or duties related to the occupation. String
recordIdOptional identifier for each input record.String

Response objects

These are returned after synchronous or asynchronous coding operations:

SynchronousCodeResponse 
FieldDescriptionType
recordIdIdentifier for the submitted input record (if originally provided).String
codeStatusCoding outcome. Valid values: successful, unsuccessful.String
inputInput record submitted to the model.RecordObject
resultList of predicted codes and labels. Min length: 0; Max: 16 (or value of numberOfSuggestions)Array of CodedRecord
AsynchronousCodeResponse
FieldDescriptionType
recordIdIdentifier for the record or empty string if none provided.String
resultTop code assigned if coding was successful.CodedRecord object
suggestionsList of alternate codes if coding was unsuccessful. Min length: 1; Max: 3Array of CodedRecord
CodedRecord
FieldDescriptionType
codeCategoryCode assigned to the input.String
codeLabelDescription of the code category.String
codeConfidenceConfidence score (e.g., 0.92). May be rounded or multiplied by 100 for a percentage. 
Back to top of the page