Sign in
DigitalOcean-public.v2-new_GradientAI Platform

List Data Sources for a Knowledge Base

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

get/v2/gen-ai/knowledge_bases/{knowledge_base_uuid}/data_sources

Path parameters

knowledge_base_uuidstring required

Knowledge base id

Query parameters

pageinteger

Page number.

per_pageinteger

Items per page.

Response

A successful response.

Example response

{
  "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",
      "dropbox_data_source": {
        "folder": "example string"
      },
      "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,
        "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"
      },
      "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
  }
}

Changes

Changed in 6 of the 8 revisions of this API.2336

  • cb3bf9b214592See the full diff
    • ○

      api tag DigitalOcean-public.v2-new_GradientAI Platform added

      api-tag-added

    • ○

      api tag GradientAI Platform removed

      api-tag-removed

    This revision also has 3 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • 9aca3802735e4See the full diff
    • ○

      added the optional property knowledge_base_data_sources/items/dropbox_data_source to the response with the 200 status

      response-optional-property-added

    • ○

      added the optional property knowledge_base_data_sources/items/last_indexing_job/total_items_failed to the response with the 200 status

      response-optional-property-added

    • ○

      added the optional property knowledge_base_data_sources/items/last_indexing_job/total_items_indexed to the response with the 200 status

      response-optional-property-added

    • ○

      added the optional property knowledge_base_data_sources/items/last_indexing_job/total_items_skipped to the response with the 200 status

      response-optional-property-added

  • f8e8c290636c10See the full diff
    • ○

      api operation id list_knowledge_base_data_sources removed and replaced with genai_list_knowledge_base_data_sources

      api-operation-id-removed

    • ○

      the endpoint scheme security bearer_auth was added to the API

      api-security-added

    • ○

      api tag GradientAI Platform added

      api-tag-added

    • ○

      api tag GenAIAPI removed

      api-tag-removed

    • ○

      for the query request parameter page, the type/format was generalized from integer/int64 to integer/

      request-parameter-type-generalized

    • ○

      for the query request parameter per_page, the type/format was generalized from integer/int64 to integer/

      request-parameter-type-generalized

    • ○

      added the non-success response with the status 401

      response-non-success-status-added

    • ○

      added the non-success response with the status 404

      response-non-success-status-added

    • ○

      added the non-success response with the status 429

      response-non-success-status-added

    • ○

      added the non-success response with the status 500

      response-non-success-status-added

    This revision also has 70 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • 5fc9af728e82238See the full diff
    • ▲

      for the query request parameter page, the type/format was changed from integer/ to integer/int64

      request-parameter-type-changed

    • ▲

      for the query request parameter per_page, the type/format was changed from integer/ to integer/int64

      request-parameter-type-changed

    • ●

      the optional response header ratelimit-limit removed for the status 200

      optional-response-header-removed

    • ●

      the optional response header ratelimit-remaining removed for the status 200

      optional-response-header-removed

    • ●

      the optional response header ratelimit-reset removed for the status 200

      optional-response-header-removed

    • ○

      api operation id genai_list_knowledge_base_data_sources removed and replaced with list_knowledge_base_data_sources

      api-operation-id-removed

    • ○

      the endpoint scheme security bearer_auth was removed from the API

      api-security-removed

    • ○

      api tag GenAIAPI added

      api-tag-added

    • ○

      api tag GradientAI Platform removed

      api-tag-removed

    • ○

      removed the non-success response with the status 401

      response-non-success-status-removed

    • ○

      removed the non-success response with the status 404

      response-non-success-status-removed

    • ○

      removed the non-success response with the status 429

      response-non-success-status-removed

    • ○

      removed the non-success response with the status 500

      response-non-success-status-removed

    This revision also has 436 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • f8e8c290636c10See the full diff
    • ○

      api operation id list_knowledge_base_data_sources removed and replaced with genai_list_knowledge_base_data_sources

      api-operation-id-removed

    • ○

      the endpoint scheme security bearer_auth was added to the API

      api-security-added

    • ○

      api tag GradientAI Platform added

      api-tag-added

    • ○

      api tag GenAIAPI removed

      api-tag-removed

    • ○

      for the query request parameter page, the type/format was generalized from integer/int64 to integer/

      request-parameter-type-generalized

    • ○

      for the query request parameter per_page, the type/format was generalized from integer/int64 to integer/

      request-parameter-type-generalized

    • ○

      added the non-success response with the status 401

      response-non-success-status-added

    • ○

      added the non-success response with the status 404

      response-non-success-status-added

    • ○

      added the non-success response with the status 429

      response-non-success-status-added

    • ○

      added the non-success response with the status 500

      response-non-success-status-added

    This revision also has 70 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • e8b3cbc80e182See the full diff
    • ○

      added the optional property knowledge_base_data_sources/items/last_datasource_indexing_job to the response with the 200 status

      response-optional-property-added

    • ○

      added the optional property knowledge_base_data_sources/items/last_indexing_job/status to the response with the 200 status

      response-optional-property-added