Skip to main content
POST
/
api
/
v2
/
documents
/
classify
Python
import os
from samplehc import SampleHealthcare

client = SampleHealthcare(
    api_key=os.environ.get("SAMPLEHC_API_KEY"),  # This is the default and can be omitted
)
response = client.v2.documents.classify(
    document={
        "id": "id",
        "file_name": "fileName",
    },
    label_schemas=[{
        "label": "label"
    }],
)
print(response.async_result_id)
{
  "asyncResultId": "<string>"
}

Body

application/json
document
object
required

The document to be classified.

labelSchemas
object[]
required

An array of label schemas to classify against.

priority
enum<string>
default:interactive

Priority of the classification job. Use 'background' for non-interactive, lower-priority jobs.

Available options:
interactive,
background

Response

Accepted. Document classification process initiated.

Accepted. Document classification process initiated.

asyncResultId
string
required

The ID to track the asynchronous classification task.