Cancel Indexing Job for a Knowledge Base

client.knowledgeBases.indexingJobs.updateCancel(, ?, ?): IndexingJobUpdateCancelResponse { job }

put/v2/gen-ai/indexing_jobs/{uuid}/cancel

To cancel an indexing job for a knowledge base, send a PUT request to /v2/gen-ai/indexing_jobs/{uuid}/cancel.

ParametersExpand Collapse

pathUuid: string

body: IndexingJobUpdateCancelParams { body_uuid }

body_uuid?: string

A unique identifier for an indexing job.

ReturnsExpand Collapse

IndexingJobUpdateCancelResponse { job }

CancelKnowledgeBaseIndexingJobOutput description

job?: APIIndexingJob { completed_datasources, created_at, data_source_jobs, 12 more }

IndexingJob description

completed_datasources?: number

Number of datasources indexed completed

formatint64

created_at?: string

Creation date / time

formatdate-time

data_source_jobs?: Array<APIIndexedDataSource { completed_at, data_source_uuid, error_details, 11 more } >

Details on Data Sources included in the Indexing Job

completed_at?: string

Timestamp when data source completed indexing

formatdate-time

data_source_uuid?: string

Uuid of the indexed data source

error_details?: string

A detailed error description

error_msg?: string

A string code provinding a hint which part of the system experienced an error

failed_item_count?: string

Total count of files that have failed

formatuint64

indexed_file_count?: string

Total count of files that have been indexed

formatuint64

indexed_item_count?: string

Total count of files that have been indexed

formatuint64

removed_item_count?: string

Total count of files that have been removed

formatuint64

skipped_item_count?: string

Total count of files that have been skipped

formatuint64

started_at?: string

Timestamp when data source started indexing

formatdate-time

status?: "DATA_SOURCE_STATUS_UNKNOWN" | "DATA_SOURCE_STATUS_IN_PROGRESS" | "DATA_SOURCE_STATUS_UPDATED" | 4 more

Accepts one of the following:

"DATA_SOURCE_STATUS_UNKNOWN"

"DATA_SOURCE_STATUS_IN_PROGRESS"

"DATA_SOURCE_STATUS_UPDATED"

"DATA_SOURCE_STATUS_PARTIALLY_UPDATED"

"DATA_SOURCE_STATUS_NOT_UPDATED"

"DATA_SOURCE_STATUS_FAILED"

"DATA_SOURCE_STATUS_CANCELLED"

total_bytes?: string

Total size of files in data source in bytes

formatuint64

total_bytes_indexed?: string

Total size of files in data source in bytes that have been indexed

formatuint64

total_file_count?: string

Total file count in the data source

formatuint64

data_source_uuids?: Array<string>

finished_at?: string

formatdate-time

is_report_available?: boolean

Boolean value to determine if the indexing job details are available

knowledge_base_uuid?: string

Knowledge base id

phase?: "BATCH_JOB_PHASE_UNKNOWN" | "BATCH_JOB_PHASE_PENDING" | "BATCH_JOB_PHASE_RUNNING" | 4 more

Accepts one of the following:

"BATCH_JOB_PHASE_UNKNOWN"

"BATCH_JOB_PHASE_PENDING"

"BATCH_JOB_PHASE_RUNNING"

"BATCH_JOB_PHASE_SUCCEEDED"

"BATCH_JOB_PHASE_FAILED"

"BATCH_JOB_PHASE_ERROR"

"BATCH_JOB_PHASE_CANCELLED"

started_at?: string

formatdate-time

status?: "INDEX_JOB_STATUS_UNKNOWN" | "INDEX_JOB_STATUS_PARTIAL" | "INDEX_JOB_STATUS_IN_PROGRESS" | 5 more

Accepts one of the following:

"INDEX_JOB_STATUS_UNKNOWN"

"INDEX_JOB_STATUS_PARTIAL"

"INDEX_JOB_STATUS_IN_PROGRESS"

"INDEX_JOB_STATUS_COMPLETED"

"INDEX_JOB_STATUS_FAILED"

"INDEX_JOB_STATUS_NO_CHANGES"

"INDEX_JOB_STATUS_PENDING"

"INDEX_JOB_STATUS_CANCELLED"

tokens?: number

Number of tokens [This field is deprecated]

formatint64

total_datasources?: number

Number of datasources being indexed

formatint64

total_tokens?: string

Total Tokens Consumed By the Indexing Job

formatuint64

updated_at?: string

Last modified

formatdate-time

uuid?: string

Unique id

Cancel Indexing Job for a Knowledge Base

import Gradient from '@digitalocean/gradient';

const client = new Gradient({
  accessToken: 'My Access Token',
});

const response = await client.knowledgeBases.indexingJobs.updateCancel(
  '"123e4567-e89b-12d3-a456-426614174000"',
);

console.log(response.job);

{
  "job": {
    "completed_datasources": 123,
    "created_at": "2023-01-01T00:00:00Z",
    "data_source_jobs": [
      {
        "completed_at": "2023-01-01T00:00:00Z",
        "data_source_uuid": "123e4567-e89b-12d3-a456-426614174000",
        "error_details": "example string",
        "error_msg": "example string",
        "failed_item_count": "12345",
        "indexed_file_count": "12345",
        "indexed_item_count": "12345",
        "removed_item_count": "12345",
        "skipped_item_count": "12345",
        "started_at": "2023-01-01T00:00:00Z",
        "status": "DATA_SOURCE_STATUS_UNKNOWN",
        "total_bytes": "12345",
        "total_bytes_indexed": "12345",
        "total_file_count": "12345"
      }
    ],
    "data_source_uuids": [
      "example string"
    ],
    "finished_at": "2023-01-01T00:00:00Z",
    "is_report_available": true,
    "knowledge_base_uuid": "123e4567-e89b-12d3-a456-426614174000",
    "phase": "BATCH_JOB_PHASE_UNKNOWN",
    "started_at": "2023-01-01T00:00:00Z",
    "status": "INDEX_JOB_STATUS_UNKNOWN",
    "tokens": 123,
    "total_datasources": 123,
    "total_tokens": "12345",
    "updated_at": "2023-01-01T00:00:00Z",
    "uuid": "123e4567-e89b-12d3-a456-426614174000"
  }
}

Returns Examples

{
  "job": {
    "completed_datasources": 123,
    "created_at": "2023-01-01T00:00:00Z",
    "data_source_jobs": [
      {
        "completed_at": "2023-01-01T00:00:00Z",
        "data_source_uuid": "123e4567-e89b-12d3-a456-426614174000",
        "error_details": "example string",
        "error_msg": "example string",
        "failed_item_count": "12345",
        "indexed_file_count": "12345",
        "indexed_item_count": "12345",
        "removed_item_count": "12345",
        "skipped_item_count": "12345",
        "started_at": "2023-01-01T00:00:00Z",
        "status": "DATA_SOURCE_STATUS_UNKNOWN",
        "total_bytes": "12345",
        "total_bytes_indexed": "12345",
        "total_file_count": "12345"
      }
    ],
    "data_source_uuids": [
      "example string"
    ],
    "finished_at": "2023-01-01T00:00:00Z",
    "is_report_available": true,
    "knowledge_base_uuid": "123e4567-e89b-12d3-a456-426614174000",
    "phase": "BATCH_JOB_PHASE_UNKNOWN",
    "started_at": "2023-01-01T00:00:00Z",
    "status": "INDEX_JOB_STATUS_UNKNOWN",
    "tokens": 123,
    "total_datasources": 123,
    "total_tokens": "12345",
    "updated_at": "2023-01-01T00:00:00Z",
    "uuid": "123e4567-e89b-12d3-a456-426614174000"
  }
}