Create

API Reference

Knowledge Bases

Indexing Jobs

Start Indexing Job for a Knowledge Base

knowledge_bases.indexing_jobs.create(IndexingJobCreateParams**kwargs) -> IndexingJobCreateResponse

post/v2/gen-ai/indexing_jobs

To start an indexing job for a knowledge base, send a POST request to /v2/gen-ai/indexing_jobs.

ParametersExpand Collapse

data_source_uuids: Optional[List[str]]

List of data source ids to index, if none are provided, all data sources will be indexed

knowledge_base_uuid: Optional[str]

Knowledge base id

ReturnsExpand Collapse

class IndexingJobCreateResponse: …

StartKnowledgeBaseIndexingJobOutput description

job: Optional[APIIndexingJob]

IndexingJob description

HTTPPython

from gradient import Gradient

client = Gradient()
indexing_job = client.knowledge_bases.indexing_jobs.create()
print(indexing_job.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"
  }
}