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>",
"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": {}
}
}
],
"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>",
"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": {}
}
}
],
"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 >= 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
"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.