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_data_source": {
"name": "<string>",
"description": "<string>",
"data_source_config": {
"source": "S3",
"s3_bucket": "<string>",
"s3_prefix": "",
"aws_region": "<string>",
"aws_account_id": "<string>"
},
"tagging_information": {
"type": "all",
"tags_to_apply": {}
},
"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_id": "<string>",
"knowledge_base_data_source_id": "<string>",
"chunking_strategy_config": {
"strategy": "character",
"separator": "\n\n",
"chunk_size": 1000,
"chunk_overlap": 200
},
"status": "HEALTHY",
"status_reason": "<string>",
"interval": 123,
"next_run_at": "2023-11-07T05:31:56Z",
"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>"
}
Gets the details of a upload schedule
This API can be used to get information about a single upload schedule by ID. To use this API, pass in the id
that was returned from your Create Upload Schedule API call as a path parameter.
Review the response schema to see the fields that will be returned.
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_data_source": {
"name": "<string>",
"description": "<string>",
"data_source_config": {
"source": "S3",
"s3_bucket": "<string>",
"s3_prefix": "",
"aws_region": "<string>",
"aws_account_id": "<string>"
},
"tagging_information": {
"type": "all",
"tags_to_apply": {}
},
"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_id": "<string>",
"knowledge_base_data_source_id": "<string>",
"chunking_strategy_config": {
"strategy": "character",
"separator": "\n\n",
"chunk_size": 1000,
"chunk_overlap": 200
},
"status": "HEALTHY",
"status_reason": "<string>",
"interval": 123,
"next_run_at": "2023-11-07T05:31:56Z",
"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>"
}
Show child attributes
Successful Response
The response is of type object
.