API Reference

Classifier

Jobs

Copy Markdown

Open in Claude

Open in ChatGPT

Open in Cursor

---

Copy Markdown

View as Markdown

Get Classification Job Results

Deprecated: Please use `client.classify.get()`

JobGetResultsResponse Classifier.Jobs.GetResults(JobGetResultsParamsparameters, CancellationTokencancellationToken = default)

GET/api/v1/classifier/jobs/{classify_job_id}/results

Get the results of a classify job. Experimental: not production-ready and subject to change.

ParametersExpand Collapse

JobGetResultsParams parameters

required string classifyJobID

string? organizationID

string? projectID

ReturnsExpand Collapse

class JobGetResultsResponse:

Response model for the classify endpoint following AIP-132 pagination standard.

required IReadOnlyList<Item> Items

The list of items.

required string ID

Unique identifier

formatuuid

required string ClassifyJobID

The ID of the classify job

formatuuid

DateTimeOffset? CreatedAt

Creation datetime

formatdate-time

string? FileID

The ID of the classified file

formatuuid

Result? Result

Result of classifying a single file.

required Double Confidence

Confidence score of the classification (0.0-1.0)

maximum1

minimum0

required string Reasoning

Step-by-step explanation of why this classification was chosen and the confidence score assigned

required string? Type

The document type that best matches, or null if no match.

DateTimeOffset? UpdatedAt

Update datetime

formatdate-time

string? NextPageToken

A token, which can be sent as page_token to retrieve the next page. If this field is omitted, there are no subsequent pages.

Long? TotalSize

The total number of items available. This is only populated when specifically requested. The value may be an estimate and can be used for display purposes only.

Get Classification Job Results

C#

HTTP

TypeScript

Python

Go

Java

C#

CLI Tool

JobGetResultsParams parameters = new()
{
    ClassifyJobID = "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e"
};

var response = await client.Classifier.Jobs.GetResults(parameters);

Console.WriteLine(response);

200 example

{
  "items": [
    {
      "id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
      "classify_job_id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
      "created_at": "2019-12-27T18:11:19.117Z",
      "file_id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
      "result": {
        "confidence": 0,
        "reasoning": "reasoning",
        "type": "type"
      },
      "updated_at": "2019-12-27T18:11:19.117Z"
    }
  ],
  "next_page_token": "next_page_token",
  "total_size": 0
}

Returns Examples

200 example

{
  "items": [
    {
      "id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
      "classify_job_id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
      "created_at": "2019-12-27T18:11:19.117Z",
      "file_id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
      "result": {
        "confidence": 0,
        "reasoning": "reasoning",
        "type": "type"
      },
      "updated_at": "2019-12-27T18:11:19.117Z"
    }
  ],
  "next_page_token": "next_page_token",
  "total_size": 0
}