import SGPClient from 'sgp';
const client = new SGPClient({
apiKey: 'My API Key',
});
// Automatically fetches more pages as needed.
for await (const knowledgeBase of client.knowledgeBases.list()) {
console.log(knowledgeBase.knowledge_base_id);
}
{
"items": [
{
"knowledge_base_id": "<string>",
"vector_store_id": "<string>",
"knowledge_base_name": "<string>",
"embedding_config": {
"type": "models_api",
"model_deployment_id": "<string>"
},
"metadata": {},
"created_at": "<string>",
"updated_at": "<string>",
"connections": [
{
"deletion_status": "DELETING",
"last_uploaded_at": "2023-11-07T05:31:56Z",
"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>"
}
}
],
"artifacts_status": {
"artifacts_chunking": 123,
"artifacts_embedding": 123,
"artifacts_completed": 123,
"artifacts_pending": 123,
"artifacts_uploading": 123,
"artifacts_failed": 123
},
"artifact_count": 123,
"cluster_status": "<string>",
"created_by_user_id": "<string>"
}
],
"total_item_count": 123,
"current_page": 123,
"items_per_page": 123
}
Lists all knowledge bases owned by the authorized user.
This API can be used to list all knowledge bases that have been created by the user. This API will return the details of all knowledge bases including their IDs, names, the embedding models they use, any metadata associated with the knowledge bases, and the timestamps for their creation, 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 knowledgeBase of client.knowledgeBases.list()) {
console.log(knowledgeBase.knowledge_base_id);
}
{
"items": [
{
"knowledge_base_id": "<string>",
"vector_store_id": "<string>",
"knowledge_base_name": "<string>",
"embedding_config": {
"type": "models_api",
"model_deployment_id": "<string>"
},
"metadata": {},
"created_at": "<string>",
"updated_at": "<string>",
"connections": [
{
"deletion_status": "DELETING",
"last_uploaded_at": "2023-11-07T05:31:56Z",
"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>"
}
}
],
"artifacts_status": {
"artifacts_chunking": 123,
"artifacts_embedding": 123,
"artifacts_completed": 123,
"artifacts_pending": 123,
"artifacts_uploading": 123,
"artifacts_failed": 123
},
"artifact_count": 123,
"cluster_status": "<string>",
"created_by_user_id": "<string>"
}
],
"total_item_count": 123,
"current_page": 123,
"items_per_page": 123
}
Optional search by account_id
Show child attributes
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
.