scheduled_indexing

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

Overview

Name	scheduled_indexing
Type	Resource
Id	digitalocean.genai.scheduled_indexing

Fields

The following fields are returned by SELECT queries:

genai_get_scheduled_indexing

A successful response.

Name	Datatype	Description
created_at	string (date-time)	Created at timestamp (example: 2023-01-01T00:00:00Z)
days	array	Days for execution (day is represented same as in a cron expression, e.g. Monday begins with 1 )
deleted_at	string (date-time)	Deleted at timestamp (if soft deleted) (example: 2023-01-01T00:00:00Z)
is_active	boolean	Whether the schedule is currently active
knowledge_base_uuid	string	Knowledge base uuid associated with this schedule (example: 123e4567-e89b-12d3-a456-426614174000)
last_ran_at	string (date-time)	Last time the schedule was executed (example: 2023-01-01T00:00:00Z)
next_run_at	string (date-time)	Next scheduled run (example: 2023-01-01T00:00:00Z)
time	string	Scheduled time of execution (HH:MM:SS format) (example: example string)
updated_at	string (date-time)	Updated at timestamp (example: 2023-01-01T00:00:00Z)
uuid	string	Unique identifier for the scheduled indexing entry (example: 123e4567-e89b-12d3-a456-426614174000)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
genai_get_scheduled_indexing	select	knowledge_base_uuid		Get Scheduled Indexing for knowledge base using knoweldge base uuid, send a GET request to /v2/gen-ai/scheduled-indexing/knowledge-base/{knowledge_base_uuid}.
genai_create_scheduled_indexing	insert			To create scheduled indexing for a knowledge base, send a POST request to /v2/gen-ai/scheduled-indexing.
genai_delete_scheduled_indexing	delete	uuid		Delete Scheduled Indexing for knowledge base, send a DELETE request to /v2/gen-ai/scheduled-indexing/{uuid}.

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	UUID of the scheduled indexing entry (example: "123e4567-e89b-12d3-a456-426614174000")
uuid	string	UUID of the scheduled indexing (example: "123e4567-e89b-12d3-a456-426614174000")

SELECT examples

genai_get_scheduled_indexing

Get Scheduled Indexing for knowledge base using knoweldge base uuid, send a GET request to /v2/gen-ai/scheduled-indexing/knowledge-base/{knowledge_base_uuid}.

SELECT
created_at,
days,
deleted_at,
is_active,
knowledge_base_uuid,
last_ran_at,
next_run_at,
time,
updated_at,
uuid
FROM digitalocean.genai.scheduled_indexing
WHERE knowledge_base_uuid = '{{ knowledge_base_uuid }}' -- required
;

INSERT examples

genai_create_scheduled_indexing

To create scheduled indexing for a knowledge base, send a POST request to /v2/gen-ai/scheduled-indexing.

INSERT INTO digitalocean.genai.scheduled_indexing (
days,
knowledge_base_uuid,
time
)
SELECT 
'{{ days }}',
'{{ knowledge_base_uuid }}',
'{{ time }}'
RETURNING
indexing_info
;

Manifest

# Description fields are for documentation purposes
- name: scheduled_indexing
props:
  - name: days
    value:
      - {{ days }}
    description: |
      Days for execution (day is represented same as in a cron expression, e.g. Monday begins with 1 )
  - name: knowledge_base_uuid
    value: "{{ knowledge_base_uuid }}"
    description: |
      Knowledge base uuid for which the schedule is created
  - name: time
    value: "{{ time }}"
    description: |
      Time of execution (HH:MM) UTC

DELETE examples

genai_delete_scheduled_indexing

Delete Scheduled Indexing for knowledge base, send a DELETE request to /v2/gen-ai/scheduled-indexing/{uuid}.

DELETE FROM digitalocean.genai.scheduled_indexing
WHERE uuid = '{{ uuid }}' --required
;