import SGPClient from 'sgp';
const client = new SGPClient({
apiKey: 'My API Key',
});
// Automatically fetches more pages as needed.
for await (const upload of client.knowledgeBases.uploads.list('knowledge_base_id')) {
console.log(upload.id);
}
{
"items": [
{
"id": "<string>",
"knowledge_base_id": "<string>",
"data_source_idempotency_key": "<string>",
"data_source_config": {
"source": "S3",
"s3_bucket": "<string>",
"s3_prefix": "",
"aws_region": "<string>",
"aws_account_id": "<string>"
},
"chunking_strategy_config": {
"strategy": "character",
"separator": "\n\n",
"chunk_size": 1000,
"chunk_overlap": 200
},
"created_at": "<string>",
"updated_at": "<string>",
"status": "<string>",
"status_reason": "<string>",
"created_by_schedule_id": "<string>"
}
],
"total_item_count": 123,
"current_page": 123,
"items_per_page": 123
}
List all uploads for a knowledge base.
This API can be used to list all uploads that have been created for a knowledge base. This API will return the details of all uploads including their IDs, their statuses, the data source configs they use, the chunking strategy configs they use, and the timestamps for their creation and last-updated time.
V2 and V1 Knowledge Bases are entirely separate and not backwards compatible. Users who have existing V1 knowledge bases will need to migrate their data to V2 knowledge bases.
import SGPClient from 'sgp';
const client = new SGPClient({
apiKey: 'My API Key',
});
// Automatically fetches more pages as needed.
for await (const upload of client.knowledgeBases.uploads.list('knowledge_base_id')) {
console.log(upload.id);
}
{
"items": [
{
"id": "<string>",
"knowledge_base_id": "<string>",
"data_source_idempotency_key": "<string>",
"data_source_config": {
"source": "S3",
"s3_bucket": "<string>",
"s3_prefix": "",
"aws_region": "<string>",
"aws_account_id": "<string>"
},
"chunking_strategy_config": {
"strategy": "character",
"separator": "\n\n",
"chunk_size": 1000,
"chunk_overlap": 200
},
"created_at": "<string>",
"updated_at": "<string>",
"status": "<string>",
"status_reason": "<string>",
"created_by_schedule_id": "<string>"
}
],
"total_item_count": 123,
"current_page": 123,
"items_per_page": 123
}
Running
, Completed
, Failed
, Canceled
Page number for pagination to be returned by the given endpoint. Starts at page 1
x >= 1
Maximum number of artifacts to be returned by the given endpoint. Defaults to 100 and cannot be greater than 10k.
1 <= x <= 10000
Successful Response
The response is of type object
.