Classify event

Delivered when a classify function chooses a category for a document. The selected label is in choice and matches one of the function version's declared classifications. When the classification model reports them, confidence and probabilities describe how certain it was; both are omitted otherwise.

For signing-secret setup and retry semantics that apply to every variant, see the Webhooks overview.

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

functionCallTryNumber?integer

The attempt number of the function call that created this event. 1 indexed.

eventID*string

Unique ID generated by bem to identify the event.

createdAt?string

Timestamp indicating when the event was created.

Formatdate-time

referenceID*string

The unique ID you use internally to refer to this data point, propagated from the original function input.

inboundEmail?

The inbound email that triggered this event.

metadata?

eventType?string

Value in"classify"

functionCallID?string

Unique identifier of function call that this event is associated with.

functionID*string

Unique identifier of function that this event is associated with.

functionName*string

Unique name of function that this event is associated with.

functionVersionNum?integer

Version number of function that this event is associated with.

callID?string

Unique identifier of workflow call that this event is associated with.

workflowID?string

Unique identifier of workflow that this event is associated with.

workflowName?string

Name of workflow that this event is associated with.

workflowVersionNum?integer

Version number of workflow that this event is associated with.

choice*string

The classification chosen by the classify function.

correctedChoice?string

The classification a user submitted as a correction through event feedback (POST /v3/events/{eventID}/feedback). Omitted until a correction is recorded. choice keeps the classification the function originally produced.

confidence?number

Confidence in choice, in the range [0, 1]. Derived from probabilities; it is not itself a probability. Its value depends on how many classifications remained after the regex and email prefilters, so it is not comparable across calls that offered the model a different number of classifications.

Present only when the classification model reports it. Omitted otherwise: for models that do not report confidence, a fallback to another model, a single remaining candidate, or a document with no extractable text classified from the file directly.

Distinct from the Evaluation confidenceScore, which an evaluator assigns per field.

Formatfloat

probabilities?object

The model's probability for each classification, keyed by classification name, with values in the range [0, 1]. Covers only the classifications offered to the model, that is, those left after the regex and email prefilters; declared classifications that were filtered out are absent.

Present and absent under the same conditions as confidence.

s3URL?string

The presigned S3 URL of the file that was classified.

Response Body

Example Requests

POST/classify

Classify event

Request Body

Response Body

2XX

Request Bodyapplication/json

See also