import SGPClient from 'sgp';
const client = new SGPClient({
apiKey: 'My API Key',
});
// Automatically fetches more pages as needed.
for await (const uploadScheduleWithViews of client.knowledgeBases.uploadSchedules.list('knowledge_base_id')) {
console.log(uploadScheduleWithViews.id);
}{
"items": [
{
"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"
}
],
"total_item_count": 123,
"current_page": 123,
"items_per_page": 123
}Lists all upload schedules accessible to the user.
This API can be used to list upload schedules. If a user has access to multiple accounts, all upload schedules from all accounts the user is associated with will be returned.
import SGPClient from 'sgp';
const client = new SGPClient({
apiKey: 'My API Key',
});
// Automatically fetches more pages as needed.
for await (const uploadScheduleWithViews of client.knowledgeBases.uploadSchedules.list('knowledge_base_id')) {
console.log(uploadScheduleWithViews.id);
}{
"items": [
{
"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"
}
],
"total_item_count": 123,
"current_page": 123,
"items_per_page": 123
}DataSource Page number for pagination to be returned by the given endpoint. Starts at page 1
x >= 1Maximum number of artifacts to be returned by the given endpoint. Defaults to 100 and cannot be greater than 10k.
1 <= x <= 10000Successful Response
The data returned for the current page.
Show child attributes
Show child attributes
"character"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.
Maximum number of characters in each chunk. If not specified, a chunk size of 1000 will be used.
x >= 1Number 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'.
x >= 0HEALTHY, UNHEALTHY, ERROR, PAUSED The unique identifier of the entity.
The date and time when the entity was created in ISO format.
The date and time when the entity was last updated in ISO format.
The user who originally created the entity.
The type of identity that created the entity.
user, service_account The ID of the account that owns the given entity.
Show child attributes
Show child attributes
"S3"Name of the S3 bucket where the data is stored.
AWS region where the S3 bucket is located.
AWS account ID that owns the S3 bucket.
Prefix of the S3 bucket where the data is stored. If not specified, the entire bucket will be used.
The unique identifier of the entity.
The date and time when the entity was created in ISO format.
The date and time when the entity was last updated in ISO format.
The user who originally created the entity.
The type of identity that created the entity.
user, service_account The ID of the account that owns the given entity.
The total number of items of the query
The current page number.
The number of items per page.