Get Classification Job Results

JobGetResultsResponse classifier().jobs().getResults(, )

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 params

Optional<String> classifyJobId

Optional<String> organizationId

Optional<String> projectId

ReturnsExpand Collapse

class JobGetResultsResponse:

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

List<Item> items

The list of items.

String id

Unique identifier

formatuuid

String classifyJobId

The ID of the classify job

formatuuid

Optional<LocalDateTime> createdAt

Creation datetime

formatdate-time

Optional<String> fileId

The ID of the classified file

formatuuid

Optional<Result> result

Result of classifying a single file.

double confidence

Confidence score of the classification (0.0-1.0)

maximum1

minimum0

String reasoning

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

Optional<String> type

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

Optional<LocalDateTime> updatedAt

Update datetime

formatdate-time

Optional<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.

Optional<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

package com.llamacloud_prod.api.example;

import com.llamacloud_prod.api.client.LlamaCloudClient;
import com.llamacloud_prod.api.client.okhttp.LlamaCloudOkHttpClient;
import com.llamacloud_prod.api.models.classifier.jobs.JobGetResultsParams;
import com.llamacloud_prod.api.models.classifier.jobs.JobGetResultsResponse;

public final class Main {
    private Main() {}

    public static void main(String[] args) {
        LlamaCloudClient client = LlamaCloudOkHttpClient.fromEnv();

        JobGetResultsResponse response = client.classifier().jobs().getResults("182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e");
    }
}

{
  "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

{
  "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
}