Skip to main content

indexing_job_data_sources

Creates, updates, deletes, gets or lists an indexing_job_data_sources resource.

Overview

Nameindexing_job_data_sources
TypeResource
Iddigitalocean.genai.indexing_job_data_sources

Fields

The following fields are returned by SELECT queries:

A successful response.

NameDatatypeDescription
completed_atstring (date-time)Timestamp when data source completed indexing (example: 2023-01-01T00:00:00Z)
data_source_uuidstringUuid of the indexed data source (example: 123e4567-e89b-12d3-a456-426614174000)
error_detailsstringA detailed error description (example: example string)
error_msgstringA string code provinding a hint which part of the system experienced an error (example: example string)
failed_item_countstring (uint64)Total count of files that have failed (example: 12345)
indexed_file_countstring (uint64)Total count of files that have been indexed (example: 12345)
indexed_item_countstring (uint64)Total count of files that have been indexed (example: 12345)
removed_item_countstring (uint64)Total count of files that have been removed (example: 12345)
skipped_item_countstring (uint64)Total count of files that have been skipped (example: 12345)
started_atstring (date-time)Timestamp when data source started indexing (example: 2023-01-01T00:00:00Z)
statusstring (default: DATA_SOURCE_STATUS_UNKNOWN, example: DATA_SOURCE_STATUS_UNKNOWN)
total_bytesstring (uint64)Total size of files in data source in bytes (example: 12345)
total_bytes_indexedstring (uint64)Total size of files in data source in bytes that have been indexed (example: 12345)
total_file_countstring (uint64)Total file count in the data source (example: 12345)

Methods

The following methods are available for this resource:

NameAccessible byRequired ParamsOptional ParamsDescription
genai_list_indexing_job_data_sourcesselectindexing_job_uuidTo list all datasources for an indexing job, send a GET request to /v2/gen-ai/indexing_jobs/{indexing_job_uuid}/data_sources.

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.

NameDatatypeDescription
indexing_job_uuidstringUuid of the indexing job (example: "123e4567-e89b-12d3-a456-426614174000")

SELECT examples

To list all datasources for an indexing job, send a GET request to /v2/gen-ai/indexing_jobs/{indexing_job_uuid}/data_sources.

SELECT
completed_at,
data_source_uuid,
error_details,
error_msg,
failed_item_count,
indexed_file_count,
indexed_item_count,
removed_item_count,
skipped_item_count,
started_at,
status,
total_bytes,
total_bytes_indexed,
total_file_count
FROM digitalocean.genai.indexing_job_data_sources
WHERE indexing_job_uuid = '{{ indexing_job_uuid }}' -- required;