List

API Reference

Knowledge Bases

List Knowledge Bases

knowledge_bases.list(KnowledgeBaseListParams**kwargs) -> KnowledgeBaseListResponse

get/v2/gen-ai/knowledge_bases

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

ParametersExpand Collapse

page: Optional[int]

Page number.

per_page: Optional[int]

Items per page.

ReturnsExpand Collapse

class KnowledgeBaseListResponse: …

List of knowledge bases

knowledge_bases: Optional[List[APIKnowledgeBase]]

The knowledge bases

added_to_agent_at: Optional[datetime]

Time when the knowledge base was added to the agent

formatdate-time

created_at: Optional[datetime]

Creation date / time

formatdate-time

database_id: Optional[str]

embedding_model_uuid: Optional[str]

is_public: Optional[bool]

Whether the knowledge base is public or not

last_indexing_job: Optional[APIIndexingJob]

IndexingJob description

name: Optional[str]

Name of knowledge base

project_id: Optional[str]

region: Optional[str]

Region code

tags: Optional[List[str]]

Tags to organize related resources

updated_at: Optional[datetime]

Last modified

formatdate-time

user_id: Optional[str]

Id of user that created the knowledge base

formatint64

uuid: Optional[str]

Unique id for knowledge base

links: Optional[APILinks]

Links to other pages

meta: Optional[APIMeta]

Meta information about the data set

HTTPPython

from gradient import Gradient

client = Gradient()
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,
        "total_items_failed": "12345",
        "total_items_indexed": "12345",
        "total_items_skipped": "12345",
        "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
  }
}

Returns Examples

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,
        "total_items_failed": "12345",
        "total_items_indexed": "12345",
        "total_items_skipped": "12345",
        "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
  }
}