knowledge_base_data_sources

Creates, updates, deletes, gets or lists a knowledge_base_data_sources resource.

Overview

Name	knowledge_base_data_sources
Type	Resource
Id	digitalocean.genai.knowledge_base_data_sources

Fields

The following fields are returned by SELECT queries:

genai_list_knowledge_base_data_sources

A successful response.

Name	Datatype	Description
knowledge_base_data_sources	array	The data sources
links	object	Links to other pages
meta	object	Meta information about the data set

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
genai_list_knowledge_base_data_sources	select	knowledge_base_uuid	page, per_page	To list all data sources for a knowledge base, send a GET request to /v2/gen-ai/knowledge_bases/{knowledge_base_uuid}/data_sources.
genai_create_knowledge_base_data_source	insert	knowledge_base_uuid		To add a data source to a knowledge base, send a POST request to /v2/gen-ai/knowledge_bases/{knowledge_base_uuid}/data_sources.
genai_delete_knowledge_base_data_source	delete	knowledge_base_uuid, data_source_uuid		To delete a data source from a knowledge base, send a DELETE request to /v2/gen-ai/knowledge_bases/{knowledge_base_uuid}/data_sources/{data_source_uuid}.
genai_create_data_source_file_upload_presigned_urls	exec			To create presigned URLs for knowledge base data source file upload, send a POST request to /v2/gen-ai/knowledge_bases/data_sources/file_upload_presigned_urls.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
data_source_uuid	string	Data source id (example: "123e4567-e89b-12d3-a456-426614174000")
knowledge_base_uuid	string	Knowledge base id (example: "123e4567-e89b-12d3-a456-426614174000")
page	integer	Page number. (example: 1)
per_page	integer	Items per page. (example: 1)

SELECT examples

genai_list_knowledge_base_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.

SELECT
knowledge_base_data_sources,
links,
meta
FROM digitalocean.genai.knowledge_base_data_sources
WHERE knowledge_base_uuid = '{{ knowledge_base_uuid }}' -- required
AND page = '{{ page }}'
AND per_page = '{{ per_page }}';

INSERT examples

genai_create_knowledge_base_data_source

To add a data source to a knowledge base, send a POST request to /v2/gen-ai/knowledge_bases/{knowledge_base_uuid}/data_sources.

INSERT INTO digitalocean.genai.knowledge_base_data_sources (
data__aws_data_source,
data__knowledge_base_uuid,
data__spaces_data_source,
data__web_crawler_data_source,
knowledge_base_uuid
)
SELECT 
'{{ aws_data_source }}',
'{{ knowledge_base_uuid }}',
'{{ spaces_data_source }}',
'{{ web_crawler_data_source }}',
'{{ knowledge_base_uuid }}'
RETURNING
knowledge_base_data_source
;

Manifest

# Description fields are for documentation purposes
- name: knowledge_base_data_sources
  props:
    - name: knowledge_base_uuid
      value: string
      description: Required parameter for the knowledge_base_data_sources resource.
    - name: aws_data_source
      value: object
      description: >
        AWS S3 Data Source
        
    - name: knowledge_base_uuid
      value: string
      description: >
        Knowledge base id
        
    - name: spaces_data_source
      value: object
      description: >
        Spaces Bucket Data Source
        
    - name: web_crawler_data_source
      value: object
      description: >
        WebCrawlerDataSource
        

DELETE examples

genai_delete_knowledge_base_data_source

To delete a data source from a knowledge base, send a DELETE request to /v2/gen-ai/knowledge_bases/{knowledge_base_uuid}/data_sources/{data_source_uuid}.

DELETE FROM digitalocean.genai.knowledge_base_data_sources
WHERE knowledge_base_uuid = '{{ knowledge_base_uuid }}' --required
AND data_source_uuid = '{{ data_source_uuid }}' --required;

Lifecycle Methods

genai_create_data_source_file_upload_presigned_urls

To create presigned URLs for knowledge base data source file upload, send a POST request to /v2/gen-ai/knowledge_bases/data_sources/file_upload_presigned_urls.

EXEC digitalocean.genai.knowledge_base_data_sources.genai_create_data_source_file_upload_presigned_urls 
@@json=
'{
"files": "{{ files }}"
}';