REreductoai

Classify

Changed on
post/classify

Request

  • Base URL
    https://platform.reducto.ai
  • Auth
    HTTP bearer

Request body

model'default' | 'accurate'

The classification model to use. Set to "accurate" to run Deep Classify for higher accuracy on hard documents. Defaults to "default".

priorityboolean

Workers poll the priority queue ahead of the standard queue, so priority jobs start sooner when there is queued work; sync jobs are prioritized above async jobs by default.

force_url_resultboolean

Force the endpoint result to be returned in URL form.

category_groupsobject

A mapping of higher-level classify groups to the category labels that belong to each group. When provided, the response includes extra_metadata.grouping with the matched group name, or ungrouped if the selected category is not in any group.

document_metadatastring nullable

Optional document-level metadata to include in classification prompts.

Response

Successful Response

response_type'classify'
job_idstring required
extra_metadataobject

Additional metadata for the classify response. Contains grouping when the request set category_groups. Omitted when empty.

durationnumber nullable

The duration of the classify request in seconds.

Changes

  • 7f4e04c7afaeRevision changes
    • breaking

      the response's property type changed from object to no type for status

    • breaking

      removed the required property / from the response with the status

    • warning

      removed the request property

    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added to the response property anyOf list for the response status

  • 66f51bc4a1bbRevision changes
    • info

      endpoint added