import SGPClient from 'sgp';
const client = new SGPClient({
apiKey: 'My API Key',
});
const knowledgeBase = await client.knowledgeBases.retrieve('knowledge_base_id');
console.log(knowledgeBase.knowledge_base_id);
{
"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>"
}
Gets the details of a knowledge base.
This API can be used to get information about a single knowledge base by ID. To use this API, pass in the knowledge_base_id
that was returned from your Create Knowledge Base API call as a path parameter.
This API will return the details of a knowledge base including its ID, name, the embedding model it uses, any metadata associated with the knowledge base, and the timestamps for its 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',
});
const knowledgeBase = await client.knowledgeBases.retrieve('knowledge_base_id');
console.log(knowledgeBase.knowledge_base_id);
{
"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>"
}
Optional query parameter to include a count of artifacts by status
Show child attributes
Successful Response
The response is of type object
.