indexing_jobs

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

Overview

Name	indexing_jobs
Type	Resource
Id	digitalocean.genai.indexing_jobs

Fields

The following fields are returned by SELECT queries:

genai_get_indexing_job

A successful response.

Name	Datatype	Description
completed_datasources	integer (int64)	Number of datasources indexed completed
created_at	string (date-time)	Creation date / time (example: 2023-01-01T00:00:00Z)
data_source_jobs	array	Details on Data Sources included in the Indexing Job
data_source_uuids	array
finished_at	string (date-time)	(example: 2023-01-01T00:00:00Z)
is_report_available	boolean	Boolean value to determine if the indexing job details are available
knowledge_base_uuid	string	Knowledge base id (example: 123e4567-e89b-12d3-a456-426614174000)
phase	string	(BATCH_JOB_PHASE_UNKNOWN, BATCH_JOB_PHASE_PENDING, BATCH_JOB_PHASE_RUNNING, BATCH_JOB_PHASE_SUCCEEDED, BATCH_JOB_PHASE_FAILED, BATCH_JOB_PHASE_ERROR, BATCH_JOB_PHASE_CANCELLED) (default: BATCH_JOB_PHASE_UNKNOWN, example: BATCH_JOB_PHASE_UNKNOWN)
started_at	string (date-time)	(example: 2023-01-01T00:00:00Z)
status	string	(INDEX_JOB_STATUS_UNKNOWN, INDEX_JOB_STATUS_PARTIAL, INDEX_JOB_STATUS_IN_PROGRESS, INDEX_JOB_STATUS_COMPLETED, INDEX_JOB_STATUS_FAILED, INDEX_JOB_STATUS_NO_CHANGES, INDEX_JOB_STATUS_PENDING, INDEX_JOB_STATUS_CANCELLED) (default: INDEX_JOB_STATUS_UNKNOWN, example: INDEX_JOB_STATUS_UNKNOWN)
tokens	integer (int64)	Number of tokens [This field is deprecated]
total_datasources	integer (int64)	Number of datasources being indexed
total_tokens	string (uint64)	Total Tokens Consumed By the Indexing Job (example: 12345)
updated_at	string (date-time)	Last modified (example: 2023-01-01T00:00:00Z)
uuid	string	Unique id (example: 123e4567-e89b-12d3-a456-426614174000)

genai_list_indexing_jobs_by_knowledge_base

A successful response.

Name	Datatype	Description
completed_datasources	integer (int64)	Number of datasources indexed completed
created_at	string (date-time)	Creation date / time (example: 2023-01-01T00:00:00Z)
data_source_jobs	array	Details on Data Sources included in the Indexing Job
data_source_uuids	array
finished_at	string (date-time)	(example: 2023-01-01T00:00:00Z)
is_report_available	boolean	Boolean value to determine if the indexing job details are available
knowledge_base_uuid	string	Knowledge base id (example: 123e4567-e89b-12d3-a456-426614174000)
phase	string	(BATCH_JOB_PHASE_UNKNOWN, BATCH_JOB_PHASE_PENDING, BATCH_JOB_PHASE_RUNNING, BATCH_JOB_PHASE_SUCCEEDED, BATCH_JOB_PHASE_FAILED, BATCH_JOB_PHASE_ERROR, BATCH_JOB_PHASE_CANCELLED) (default: BATCH_JOB_PHASE_UNKNOWN, example: BATCH_JOB_PHASE_UNKNOWN)
started_at	string (date-time)	(example: 2023-01-01T00:00:00Z)
status	string	(INDEX_JOB_STATUS_UNKNOWN, INDEX_JOB_STATUS_PARTIAL, INDEX_JOB_STATUS_IN_PROGRESS, INDEX_JOB_STATUS_COMPLETED, INDEX_JOB_STATUS_FAILED, INDEX_JOB_STATUS_NO_CHANGES, INDEX_JOB_STATUS_PENDING, INDEX_JOB_STATUS_CANCELLED) (default: INDEX_JOB_STATUS_UNKNOWN, example: INDEX_JOB_STATUS_UNKNOWN)
tokens	integer (int64)	Number of tokens [This field is deprecated]
total_datasources	integer (int64)	Number of datasources being indexed
total_tokens	string (uint64)	Total Tokens Consumed By the Indexing Job (example: 12345)
updated_at	string (date-time)	Last modified (example: 2023-01-01T00:00:00Z)
uuid	string	Unique id (example: 123e4567-e89b-12d3-a456-426614174000)

genai_list_indexing_jobs

A successful response.

Name	Datatype	Description
jobs	array	The indexing jobs
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_get_indexing_job	select	uuid		To get status of an indexing Job for a knowledge base, send a GET request to /v2/gen-ai/indexing_jobs/{uuid}.
genai_list_indexing_jobs_by_knowledge_base	select	knowledge_base_uuid		To list latest 15 indexing jobs for a knowledge base, send a GET request to /v2/gen-ai/knowledge_bases/{knowledge_base_uuid}/indexing_jobs.
genai_list_indexing_jobs	select		page, per_page	To list all indexing jobs for a knowledge base, send a GET request to /v2/gen-ai/indexing_jobs.
genai_create_indexing_job	insert			To start an indexing job for a knowledge base, send a POST request to /v2/gen-ai/indexing_jobs.
genai_cancel_indexing_job	replace	uuid		To cancel an indexing job for a knowledge base, send a PUT request to /v2/gen-ai/indexing_jobs/{uuid}/cancel.

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
knowledge_base_uuid	string	Knowledge base uuid in string (example: "123e4567-e89b-12d3-a456-426614174000")
uuid	string	A unique identifier for an indexing job. (example: "123e4567-e89b-12d3-a456-426614174000")
page	integer	Page number. (example: 1)
per_page	integer	Items per page. (example: 1)

SELECT examples

genai_get_indexing_job

To get status of an indexing Job for a knowledge base, send a GET request to /v2/gen-ai/indexing_jobs/{uuid}.

SELECT
completed_datasources,
created_at,
data_source_jobs,
data_source_uuids,
finished_at,
is_report_available,
knowledge_base_uuid,
phase,
started_at,
status,
tokens,
total_datasources,
total_tokens,
updated_at,
uuid
FROM digitalocean.genai.indexing_jobs
WHERE uuid = '{{ uuid }}' -- required
;

genai_list_indexing_jobs_by_knowledge_base

To list latest 15 indexing jobs for a knowledge base, send a GET request to /v2/gen-ai/knowledge_bases/{knowledge_base_uuid}/indexing_jobs.

SELECT
completed_datasources,
created_at,
data_source_jobs,
data_source_uuids,
finished_at,
is_report_available,
knowledge_base_uuid,
phase,
started_at,
status,
tokens,
total_datasources,
total_tokens,
updated_at,
uuid
FROM digitalocean.genai.indexing_jobs
WHERE knowledge_base_uuid = '{{ knowledge_base_uuid }}' -- required
;

genai_list_indexing_jobs

To list all indexing jobs for a knowledge base, send a GET request to /v2/gen-ai/indexing_jobs.

SELECT
jobs,
links,
meta
FROM digitalocean.genai.indexing_jobs
WHERE page = '{{ page }}'
AND per_page = '{{ per_page }}'
;

INSERT examples

genai_create_indexing_job

To start an indexing job for a knowledge base, send a POST request to /v2/gen-ai/indexing_jobs.

INSERT INTO digitalocean.genai.indexing_jobs (
data_source_uuids,
knowledge_base_uuid
)
SELECT 
'{{ data_source_uuids }}',
'{{ knowledge_base_uuid }}'
RETURNING
job
;

Manifest

# Description fields are for documentation purposes
- name: indexing_jobs
props:
  - name: data_source_uuids
    value:
      - "{{ data_source_uuids }}"
    description: |
      List of data source ids to index, if none are provided, all data sources will be indexed
  - name: knowledge_base_uuid
    value: "{{ knowledge_base_uuid }}"
    description: |
      Knowledge base id

REPLACE examples

genai_cancel_indexing_job

To cancel an indexing job for a knowledge base, send a PUT request to /v2/gen-ai/indexing_jobs/{uuid}/cancel.

REPLACE digitalocean.genai.indexing_jobs
SET 
uuid = '{{ uuid }}'
WHERE 
uuid = '{{ uuid }}' --required
RETURNING
job;