Skip to content
Gradient SDK Docs
  • Auto
  • Light
  • Dark

List

List Knowledge Bases
knowledge_bases.list(KnowledgeBaseListParams**kwargs) -> knowledge_baseslistlinksAPILinksmetaAPIMetaKnowledgeBaseListResponse
get/v2/gen-ai/knowledge_bases

To list all knowledge bases, send a GET request to /v2/gen-ai/knowledge_bases.

Parameters
pageint
optional

Page number.

per_pageint
optional

Items per page.

Returns
KnowledgeBaseListResponseclass

List of knowledge bases

Hide ParametersShow Parameters
knowledge_baseslist
optional
Optional[List[added_to_agent_atdatetimecreated_atdatetimedatabase_idstrembedding_model_uuidstris_publicboollast_indexing_jobAPIIndexingJobnamestrproject_idstrregionstrtagslistupdated_atdatetimeuser_idstruuidstrAPIKnowledgeBase]]

The knowledge bases

Hide ParametersShow Parameters
added_to_agent_atdatetime
optional

Time when the knowledge base was added to the agent

formatdate-time
created_atdatetime
optional

Creation date / time

formatdate-time
database_idstr
optional
embedding_model_uuidstr
optional
is_publicbool
optional

Whether the knowledge base is public or not

last_indexing_jobAPIIndexingJob
optional

IndexingJob description

namestr
optional

Name of knowledge base

project_idstr
optional
regionstr
optional

Region code

tagslist
optional
Optional[List[str]]

Tags to organize related resources

updated_atdatetime
optional

Last modified

formatdate-time
user_idstr
optional

Id of user that created the knowledge base

formatint64
uuidstr
optional

Unique id for knowledge base

metaAPIMeta
optional

Meta information about the data set

from do_gradientai import GradientAI

client = GradientAI()
knowledge_bases = client.knowledge_bases.list()
print(knowledge_bases.knowledge_bases)
200 Example
{
  "knowledge_bases": [
    {
      "added_to_agent_at": "2023-01-01T00:00:00Z",
      "created_at": "2023-01-01T00:00:00Z",
      "database_id": "\"123e4567-e89b-12d3-a456-426614174000\"",
      "embedding_model_uuid": "\"123e4567-e89b-12d3-a456-426614174000\"",
      "is_public": true,
      "last_indexing_job": {
        "completed_datasources": 123,
        "created_at": "2023-01-01T00:00:00Z",
        "data_source_uuids": [
          "example string"
        ],
        "finished_at": "2023-01-01T00:00:00Z",
        "knowledge_base_uuid": "\"123e4567-e89b-12d3-a456-426614174000\"",
        "phase": "BATCH_JOB_PHASE_UNKNOWN",
        "started_at": "2023-01-01T00:00:00Z",
        "status": "INDEX_JOB_STATUS_UNKNOWN",
        "tokens": 123,
        "total_datasources": 123,
        "updated_at": "2023-01-01T00:00:00Z",
        "uuid": "\"123e4567-e89b-12d3-a456-426614174000\""
      },
      "name": "\"example name\"",
      "project_id": "\"123e4567-e89b-12d3-a456-426614174000\"",
      "region": "\"example string\"",
      "tags": [
        "example string"
      ],
      "updated_at": "2023-01-01T00:00:00Z",
      "user_id": "user_id",
      "uuid": "\"123e4567-e89b-12d3-a456-426614174000\""
    }
  ],
  "links": {
    "pages": {
      "first": "\"example string\"",
      "last": "\"example string\"",
      "next": "\"example string\"",
      "previous": "\"example string\""
    }
  },
  "meta": {
    "page": 123,
    "pages": 123,
    "total": 123
  }
}