Get Upload Schedule

JavaScript

import SGPClient from 'sgp';

const client = new SGPClient({
  apiKey: 'My API Key',
});

const uploadScheduleWithViews = await client.knowledgeBases.uploadSchedules.retrieve(
  'knowledge_base_id',
  'upload_schedule_id',
);

console.log(uploadScheduleWithViews.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>",
  "knowledge_base_data_source": {
    "name": "<string>",
    "data_source_config": {
      "source": "<string>",
      "s3_bucket": "<string>",
      "aws_region": "<string>",
      "aws_account_id": "<string>",
      "s3_prefix": ""
    },
    "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>",
    "description": "<string>",
    "tagging_information": {
      "type": "all",
      "tags_to_apply": {}
    }
  },
  "status_reason": "<string>",
  "next_run_at": "2023-11-07T05:31:56Z"
}

GET

knowledge-bases

{knowledge_base_id}

upload-schedules

{upload_schedule_id}

JavaScript

import SGPClient from 'sgp';

const client = new SGPClient({
  apiKey: 'My API Key',
});

const uploadScheduleWithViews = await client.knowledgeBases.uploadSchedules.retrieve(
  'knowledge_base_id',
  'upload_schedule_id',
);

console.log(uploadScheduleWithViews.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>",
  "knowledge_base_data_source": {
    "name": "<string>",
    "data_source_config": {
      "source": "<string>",
      "s3_bucket": "<string>",
      "aws_region": "<string>",
      "aws_account_id": "<string>",
      "s3_prefix": ""
    },
    "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>",
    "description": "<string>",
    "tagging_information": {
      "type": "all",
      "tags_to_apply": {}
    }
  },
  "status_reason": "<string>",
  "next_run_at": "2023-11-07T05:31:56Z"
}

Authorizations

x-api-key

string

header

required

Path Parameters

knowledge_base_id

string

required

upload_schedule_id

string

required

Query Parameters

view

enum<string>[]

Available options:

DataSource

Response

Successful Response

knowledge_base_id

string

required

knowledge_base_data_source_id

string

required

chunking_strategy_config

CharacterChunkingStrategyConfig · object

required

CharacterChunkingStrategyConfig
TokenChunkingStrategyConfig
CustomChunkingStrategyConfig
PreChunkedStrategyConfig
EnhancedChunkingStrategyConfig

Show child attributes

chunking_strategy_config.strategy

string

required

Allowed value: "character"

chunking_strategy_config.separator

string

default:

Character designating breaks in input data. Text data will first be split into sections by this separator, then each section will be split into chunks of size chunk_size.

chunking_strategy_config.chunk_size

integer

default:1000

Maximum number of characters in each chunk. If not specified, a chunk size of 1000 will be used.

Required range: x >= 1

chunking_strategy_config.chunk_overlap

integer

default:200

Number of characters to overlap between chunks. If not specified, an overlap of 200 will be used. For example if the chunk size is 3 and the overlap size is 1, and the text to chunk is 'abcde', the chunks will be 'abc', 'cde'.

Required range: x >= 0

status

enum<string>

required

Available options:

HEALTHY,

UNHEALTHY,

ERROR,

PAUSED

interval

number

required

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.

knowledge_base_data_source

KnowledgeBaseDataSourceResponse · object

Show child attributes

knowledge_base_data_source.name

string

required

knowledge_base_data_source.data_source_config

S3 DataSource Config · object

required

S3 DataSource Config
SharePoint DataSource Config
SharePoint Page DataSource Config
Google Drive DataSource Config
Azure Blob Storage DataSource Config
Confluence DataSource Config
Slack DataSource Config
Snowflake DataSource Config
Databricks DataSource Config

Show child attributes

knowledge_base_data_source.data_source_config.source

string

required

Allowed value: "S3"

knowledge_base_data_source.data_source_config.s3_bucket

string

required

Name of the S3 bucket where the data is stored.

knowledge_base_data_source.data_source_config.aws_region

string

required

AWS region where the S3 bucket is located.

knowledge_base_data_source.data_source_config.aws_account_id

string

required

AWS account ID that owns the S3 bucket.

knowledge_base_data_source.data_source_config.s3_prefix

string

default:""

Prefix of the S3 bucket where the data is stored. If not specified, the entire bucket will be used.

knowledge_base_data_source.id

string

required

The unique identifier of the entity.

knowledge_base_data_source.created_at

string<date-time>

required

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

knowledge_base_data_source.updated_at

string<date-time>

required

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

knowledge_base_data_source.created_by_user_id

string

required

The user who originally created the entity.

knowledge_base_data_source.created_by_identity_type

enum<string>

required

The type of identity that created the entity.

Available options:

user,

service_account

knowledge_base_data_source.account_id

string

required

The ID of the account that owns the given entity.

knowledge_base_data_source.description

string

knowledge_base_data_source.tagging_information

TaggingInformationAll · object

Show child attributes

knowledge_base_data_source.tagging_information.type

string

default:all

Allowed value: "all"

knowledge_base_data_source.tagging_information.tags_to_apply

Tags To Apply · object

status_reason

string

next_run_at

string<date-time>

Create Upload Schedule Delete Upload Schedule

⌘I

Knowledge Bases

Chunks

Agents

Completions

Chat Completions

Models

Users

Accounts

Organizations

Question Sets

Evaluations

Evaluation Configs

Evaluation Datasets

Studio Projects

Application Specs

Questions

Knowledge Base Data Sources

Model Templates V3 (Beta)

Model server

API Reference

Fine Tuning Jobs V3 (Beta)

Training Datasets V3 (Beta)

package deployments

Beta

Applications

ChatThreads

Interactions

MonitoringDashboard

Chat Themes

account groups

Get Upload Schedule

Description

Details

Authorizations

Path Parameters

Query Parameters

Response