GET
/
v4
/
knowledge-bases
/
{knowledge_base_id}
import SGPClient from 'sgp';

const client = new SGPClient({
  apiKey: process.env['SGP_API_KEY'], // This is the default and can be omitted
});

async function main() {
  const knowledgeBase = await client.knowledgeBases.retrieve('knowledge_base_id');

  console.log(knowledgeBase.knowledge_base_id);
}

main();
{
  "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>",
        "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>"
}

Authorizations

x-api-key
string
header
required

Path Parameters

knowledge_base_id
string
required

Query Parameters

include_artifacts_status
boolean
default:false

Optional query parameter to include a count of artifacts by status

view
enum<string>[]

Response

200
application/json

Successful Response

The response is of type object.