Document

Classify document by type (sync)

Note: Use this Classify endpoint for testing. Use the asynchronous Classify endpoint for production.

Score a document’s similarity to each document type you defined in your Sensible account. Get scores for the document’s similarity to document types and to their reference documents.

Use this endpoint:

In an extraction workflow. For example, determine which documents to extract prior to calling a Sensible extraction endpoint.
Outside an extraction workflow. For example, determine where to route each document or to label each document in a system of record.

To post the document bytes, specify the non-encoded document bytes as the entire request body,and specify the Content-Type header, for example,“application/pdf” or “image/jpeg”.

For supported file size and types, see Supported file types.

POST

classify

curl --request POST \
  --url https://api.sensible.so/v0/classify \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: image/jpeg'

{
  "document_type": {
    "id": "77c2ab88-3389-4ea8-93c7-912c2bfd373a",
    "name": "tax_forms",
    "score": 0.9637581544082083
  },
  "reference_documents": [
    {
      "id": "b4fbc822-de99-4916-b43a-2902131f2619",
      "name": "1040_2020_sample",
      "score": 0.999649884175599
    },
    {
      "id": "23680cc8-7855-4698-b51f-6a054704fd1e",
      "name": "1040_2019_sample",
      "score": 0.983879165384638
    },
    {
      "id": "58aef918-7017-4576-ad5c-f987b98b4ae7",
      "name": "1040_2021_sample",
      "score": 0.9670293766923486
    },
    {
      "id": "161b27ab-5218-4650-a919-65df03de3454",
      "name": "senior_1040_2021_sample",
      "score": 0.939401195335292
    },
    {
      "id": "fb9ed1c3-0545-4f79-bd00-565838bd96a4",
      "name": "1040_2018_sample",
      "score": 0.9288311504531641
    }
  ],
  "classification_summary": [
    {
      "id": "28eee728-e51b-471c-ba92-827c995476f6",
      "name": "home_policy_declaration_pages",
      "score": 0.7760597095611765
    },
    {
      "id": "16b06941-9486-475a-a6bf-120cf433f6f3",
      "name": "bank_statements",
      "score": 0.7639481987557378
    }
  ]
}

Authorizations

Authorization

string

header

required

Sensible uses API keys to authenticate requests. Keep your API keys secure and do not share them publicly accessible areas such as GitHub, client-side code, etc. Authentication to the API is performed via Bearer Authentication. Provide your API key as the bearer auth value.

Body

The body is of type file.

Response

200

application/json

The document type and reference documents in the Sensible account that are most similar to this document.

document_type

object

Document type defined in the Sensible account that this doc is most similar to. To use a document type for classification, Sensible requires that the type contains at least one reference document.

reference_documents

object[]

Reference documents uploaded to the Sensible account that this document is most similar to.

classification_summary

object[]

Scores for this document's similarity to each document type in the Sensible account, excluding document types Sensible created in your account as tutorials, such as senseml_basics.

Classify document by type List document types for this account

curl --request POST \
  --url https://api.sensible.so/v0/classify \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: image/jpeg'

{
  "document_type": {
    "id": "77c2ab88-3389-4ea8-93c7-912c2bfd373a",
    "name": "tax_forms",
    "score": 0.9637581544082083
  },
  "reference_documents": [
    {
      "id": "b4fbc822-de99-4916-b43a-2902131f2619",
      "name": "1040_2020_sample",
      "score": 0.999649884175599
    },
    {
      "id": "23680cc8-7855-4698-b51f-6a054704fd1e",
      "name": "1040_2019_sample",
      "score": 0.983879165384638
    },
    {
      "id": "58aef918-7017-4576-ad5c-f987b98b4ae7",
      "name": "1040_2021_sample",
      "score": 0.9670293766923486
    },
    {
      "id": "161b27ab-5218-4650-a919-65df03de3454",
      "name": "senior_1040_2021_sample",
      "score": 0.939401195335292
    },
    {
      "id": "fb9ed1c3-0545-4f79-bd00-565838bd96a4",
      "name": "1040_2018_sample",
      "score": 0.9288311504531641
    }
  ],
  "classification_summary": [
    {
      "id": "28eee728-e51b-471c-ba92-827c995476f6",
      "name": "home_policy_declaration_pages",
      "score": 0.7760597095611765
    },
    {
      "id": "16b06941-9486-475a-a6bf-120cf433f6f3",
      "name": "bank_statements",
      "score": 0.7639481987557378
    }
  ]
}

Introduction

Extraction

Classification

Configuration

Classify document by type (sync)

Authorizations

Body

Response