import SGPClient from 'sgp';
const client = new SGPClient({
apiKey: process.env['SGP_API_KEY'], // This is the default and can be omitted
});
const knowledgeBaseDataSource = await client.knowledgeBaseDataSources.retrieve(
'knowledge_base_data_source_id',
);
console.log(knowledgeBaseDataSource.id);
{
"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>",
"account_id": "<string>"
}
Gets the details of a knowledge base data source
This API can be used to get information about a single knowledge base data source by ID. To use this API, pass in the id
that was returned from your Create Knowledge Base Data Source API call as a path parameter.
Review the response schema to see the fields that will be returned.
import SGPClient from 'sgp';
const client = new SGPClient({
apiKey: process.env['SGP_API_KEY'], // This is the default and can be omitted
});
const knowledgeBaseDataSource = await client.knowledgeBaseDataSources.retrieve(
'knowledge_base_data_source_id',
);
console.log(knowledgeBaseDataSource.id);
{
"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>",
"account_id": "<string>"
}
Successful Response
The response is of type object
.