Skip to main content
POST
/
v4
/
knowledge-bases
/
{knowledge_base_id}
/
upload-schedules
Python
import os
from scale_gp import SGPClient

client = SGPClient(
    api_key=os.environ.get("SGP_API_KEY"),  # This is the default and can be omitted
)
upload_schedule = client.knowledge_bases.upload_schedules.create(
    knowledge_base_id="knowledge_base_id",
    chunking_strategy_config={
        "strategy": "character"
    },
    interval=0,
    knowledge_base_data_source_id="knowledge_base_data_source_id",
)
print(upload_schedule.id)
{
  "knowledge_base_id": "<string>",
  "knowledge_base_data_source_id": "<string>",
  "chunking_strategy_config": {
    "strategy": "<string>",
    "separator": "\n\n",
    "chunk_size": 1000,
    "chunk_overlap": 200
  },
  "status": "HEALTHY",
  "interval": 123,
  "id": "<string>",
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z",
  "created_by_user_id": "<string>",
  "created_by_identity_type": "user",
  "account_id": "<string>",
  "status_reason": "<string>",
  "next_run_at": "2023-11-07T05:31:56Z"
}

Authorizations

x-api-key
string
header
required

Headers

x-selected-account-id
string | null

Path Parameters

knowledge_base_id
string
required

Body

application/json
knowledge_base_data_source_id
string
required
chunking_strategy_config
CharacterChunkingStrategyConfig · object
required
interval
number
required
next_run_at
string<date-time>
account_id
string

The ID of the account that owns the given entity.

Response

Successful Response

knowledge_base_id
string
required
knowledge_base_data_source_id
string
required
chunking_strategy_config
CharacterChunkingStrategyConfig · object
required
status
enum<string>
required
Available options:
HEALTHY,
UNHEALTHY,
ERROR,
PAUSED
interval
number
required
id
string
required

The unique identifier of the entity.

created_at
string<date-time>
required

The date and time when the entity was created in ISO format.

updated_at
string<date-time>
required

The date and time when the entity was last updated in ISO format.

created_by_user_id
string
required

The user who originally created the entity.

created_by_identity_type
enum<string>
required

The type of identity that created the entity.

Available options:
user,
service_account
account_id
string
required

The ID of the account that owns the given entity.

status_reason
string
next_run_at
string<date-time>