get_labels_for_dataset_file

DatasetsApi.get_labels_for_dataset_file(id, role_id, file_name, _request_timeout=None, _request_auth=None, _content_type=None, _headers=None, _host_index=0)

Get generated labels for a dataset file

Returns the generated labels for a single file and the current state of label generation. Status is reported as pending when labels have never been requested for the file.

Parameters:

  • id (str) – Dataset id. (required)

  • role_id (str) – User role id (required)

  • file_name (str) – Full object key of the file, exactly as returned in FileName by GET /datasets/{id}/files. (required)

  • _request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

  • _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

  • _content_type (str, Optional) – force content-type for the request.

  • _headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.

  • _host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Return type:

GetLabelsResponse

Returns:

Returns the result object.

Request and Response Examples

HTTP: GET /datasets/{id}/files/labels

Success (HTTP 200)

Successful API response

Labels generated and awaiting review

{
  "LabelMetadata": {
    "invoice": "PENDING",
    "quarterly-report": "APPROVED"
  },
  "LabelGenerationStatus": "completed"
}

Labels have never been requested for the file

{
  "LabelMetadata": {},
  "LabelGenerationStatus": "pending"
}

Errors

Documented error codes: IPV-1020, IPV-1002, AI-1004.

HTTP 400

Missing required request parameters

HTTP 500

Something went wrong at backend. Input, permission and file-state errors - such as an unsupported file type, a file that is already processed, or a dataset you cannot access - are also reported here.

file-name empty once past gateway validation

{
  "Message": "IPV-1020 - Input key 'file-name' is missing."
}

DatasetId does not exist

{
  "Message": "IPV-1002 - Invalid DatasetId - b1e6c2a0-9f4d-4c7a-8f2e-1a2b3c4d5e6f, resource not found."
}

Datasets AI service is switched off

{
  "Message": "AI-1004 - AI services for feature: Datasets are not currently enabled in the application. Please contact the administrator to enable it."
}