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

List

List Data Sources for a Knowledge Base
knowledge_bases.data_sources.list(strknowledge_base_uuid, DataSourceListParams**kwargs) -> knowledge_base_data_sourceslistlinksAPILinksmetaAPIMetaDataSourceListResponse
get/v2/gen-ai/knowledge_bases/{knowledge_base_uuid}/data_sources

To list all data sources for a knowledge base, send a GET request to /v2/gen-ai/knowledge_bases/{knowledge_base_uuid}/data_sources.

Parameters
knowledge_base_uuidstr
pageint
optional

Page number.

per_pageint
optional

Items per page.

Returns
DataSourceListResponseclass

A list of knowledge base data sources

Hide ParametersShow Parameters
knowledge_base_data_sourceslist
optional
Optional[List[aws_data_sourceAwsDataSourcebucket_namestrcreated_atdatetimefile_upload_data_sourceAPIFileUploadDataSourceitem_pathstrlast_datasource_indexing_jobAPIIndexedDataSourcelast_indexing_jobAPIIndexingJobregionstrspaces_data_sourceAPISpacesDataSourceupdated_atdatetimeuuidstrweb_crawler_data_sourceAPIWebCrawlerDataSourceAPIKnowledgeBaseDataSource]]

The data sources

Hide ParametersShow Parameters
aws_data_sourcebucket_namestritem_pathstrregionstrAwsDataSource
optional

AWS S3 Data Source for Display

Hide ParametersShow Parameters
bucket_namestr
optional

Spaces bucket name

item_pathstr
optional
regionstr
optional

Region of bucket

bucket_namestr
optional

Name of storage bucket - Deprecated, moved to data_source_details

created_atdatetime
optional

Creation date / time

formatdate-time
file_upload_data_sourceAPIFileUploadDataSource
optional

File to upload as data source for knowledge base.

item_pathstr
optional

Path of folder or object in bucket - Deprecated, moved to data_source_details

last_datasource_indexing_jobAPIIndexedDataSource
optional
last_indexing_jobAPIIndexingJob
optional

IndexingJob description

regionstr
optional

Region code - Deprecated, moved to data_source_details

spaces_data_sourceAPISpacesDataSource
optional

Spaces Bucket Data Source

updated_atdatetime
optional

Last modified

formatdate-time
uuidstr
optional

Unique id of knowledge base

web_crawler_data_sourceAPIWebCrawlerDataSource
optional

WebCrawlerDataSource

metaAPIMeta
optional

Meta information about the data set

from do_gradientai import GradientAI

client = GradientAI()
data_sources = client.knowledge_bases.data_sources.list(
    knowledge_base_uuid="\"123e4567-e89b-12d3-a456-426614174000\"",
)
print(data_sources.knowledge_base_data_sources)
200 Example
{
  "knowledge_base_data_sources": [
    {
      "aws_data_source": {
        "bucket_name": "\"example name\"",
        "item_path": "\"example string\"",
        "region": "\"example string\""
      },
      "bucket_name": "\"example name\"",
      "created_at": "2023-01-01T00:00:00Z",
      "file_upload_data_source": {
        "original_file_name": "\"example name\"",
        "size_in_bytes": "\"12345\"",
        "stored_object_key": "\"example string\""
      },
      "item_path": "\"example string\"",
      "last_datasource_indexing_job": {
        "completed_at": "2023-01-01T00:00:00Z",
        "data_source_uuid": "\"123e4567-e89b-12d3-a456-426614174000\"",
        "error_details": "\"example string\"",
        "error_msg": "\"example string\"",
        "failed_item_count": "\"12345\"",
        "indexed_file_count": "\"12345\"",
        "indexed_item_count": "\"12345\"",
        "removed_item_count": "\"12345\"",
        "skipped_item_count": "\"12345\"",
        "started_at": "2023-01-01T00:00:00Z",
        "status": "DATA_SOURCE_STATUS_UNKNOWN",
        "total_bytes": "\"12345\"",
        "total_bytes_indexed": "\"12345\"",
        "total_file_count": "\"12345\""
      },
      "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\""
      },
      "region": "\"example string\"",
      "spaces_data_source": {
        "bucket_name": "\"example name\"",
        "item_path": "\"example string\"",
        "region": "\"example string\""
      },
      "updated_at": "2023-01-01T00:00:00Z",
      "uuid": "\"123e4567-e89b-12d3-a456-426614174000\"",
      "web_crawler_data_source": {
        "base_url": "\"example string\"",
        "crawling_option": "UNKNOWN",
        "embed_media": true
      }
    }
  ],
  "links": {
    "pages": {
      "first": "\"example string\"",
      "last": "\"example string\"",
      "next": "\"example string\"",
      "previous": "\"example string\""
    }
  },
  "meta": {
    "page": 123,
    "pages": 123,
    "total": 123
  }
}