Update Cancel

API Reference

Knowledge Bases

Indexing Jobs

Cancel Indexing Job for a Knowledge Base

knowledge_bases.indexing_jobs.update_cancel(strpath_uuid, IndexingJobUpdateCancelParams**kwargs) -> IndexingJobUpdateCancelResponse

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

uuid: str

uuid: str

ReturnsExpand Collapse

class IndexingJobUpdateCancelResponse: …

CancelKnowledgeBaseIndexingJobOutput description

job: Optional[APIIndexingJob]

IndexingJob description

completed_datasources: Optional[int]

Number of datasources indexed completed

formatint64

created_at: Optional[datetime]

Creation date / time

formatdate-time

data_source_uuids: Optional[List[str]]

finished_at: Optional[datetime]

formatdate-time

knowledge_base_uuid: Optional[str]

Knowledge base id

phase: Optional[Literal["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: Optional[datetime]

formatdate-time

status: Optional[Literal["INDEX_JOB_STATUS_UNKNOWN", "INDEX_JOB_STATUS_PARTIAL", "INDEX_JOB_STATUS_IN_PROGRESS", 4 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"

tokens: Optional[int]

Number of tokens

formatint64

total_datasources: Optional[int]

Number of datasources being indexed

formatint64

total_items_failed: Optional[str]

Total Items Failed

formatuint64

total_items_indexed: Optional[str]

Total Items Indexed

formatuint64

total_items_skipped: Optional[str]

Total Items Skipped

formatuint64

updated_at: Optional[datetime]

Last modified

formatdate-time

uuid: Optional[str]

Unique id

Cancel Indexing Job for a Knowledge Base

python

• http
• typescript
• python

from gradient import Gradient

client = Gradient(
    access_token="My Access Token",
)
response = client.knowledge_bases.indexing_jobs.update_cancel(
    path_uuid="\"123e4567-e89b-12d3-a456-426614174000\"",
)
print(response.job)

200 example

{
  "job": {
    "completed_datasources": 123,
    "created_at": "2023-01-01T00:00:00Z",
    "data_source_uuids": [
      "example string"
    ],
    "finished_at": "2023-01-01T00:00:00Z",
    "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_items_failed": "12345",
    "total_items_indexed": "12345",
    "total_items_skipped": "12345",
    "updated_at": "2023-01-01T00:00:00Z",
    "uuid": "123e4567-e89b-12d3-a456-426614174000"
  }
}

Returns Examples

200 example

{
  "job": {
    "completed_datasources": 123,
    "created_at": "2023-01-01T00:00:00Z",
    "data_source_uuids": [
      "example string"
    ],
    "finished_at": "2023-01-01T00:00:00Z",
    "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_items_failed": "12345",
    "total_items_indexed": "12345",
    "total_items_skipped": "12345",
    "updated_at": "2023-01-01T00:00:00Z",
    "uuid": "123e4567-e89b-12d3-a456-426614174000"
  }
}