import SGPClient from 'sgp';
const client = new SGPClient({
apiKey: 'My API Key',
});
// Automatically fetches more pages as needed.
for await (const knowledgeBaseDataSource of client.knowledgeBaseDataSources.list()) {
console.log(knowledgeBaseDataSource.id);
}
{
"items": [
{
"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>"
}
],
"total_item_count": 123,
"current_page": 123,
"items_per_page": 123
}
Lists all knowledge base data sources accessible to the user.
This API can be used to list knowledge base data sources. If a user has access to multiple accounts, all knowledge base data sources 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 knowledgeBaseDataSource of client.knowledgeBaseDataSources.list()) {
console.log(knowledgeBaseDataSource.id);
}
{
"items": [
{
"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>"
}
],
"total_item_count": 123,
"current_page": 123,
"items_per_page": 123
}
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
.