Update Dataset Ingestion Task

PUThttps://api.confident-ai.com/v1/datasets/{alias}/dataset-ingestion-tasks/{datasetIngestionTaskId}

Updates an ingestion task. Only the fields you send are changed; omitting a field leaves it untouched, and sending null clears it.

Toggling enabled schedules or unschedules the harvesting job. Requires the Starter plan or above.

PUT/v1/datasets/{alias}/dataset-ingestion-tasks/{datasetIngestionTaskId}

curl -X PUT "https://api.confident-ai.com/v1/datasets/{alias}/dataset-ingestion-tasks/{datasetIngestionTaskId}" \
  -H "CONFIDENT_API_KEY: <PROJECT-API-KEY>" \
  -H "Content-Type: application/json" \
  -d '{
  "enabled": false
}'

200

{
  "success": true,
  "data": {
    "datasetIngestionTask": {
      "id": "INGESTION-TASK-ID",
      "name": "Harvest failed checkouts",
      "enabled": false,
      "sampleRate": 0.1,
      "dataModel": "TRACE"
    }
  },
  "link": "https://app.confident-ai.com/project/<PROJECT-ID>/workflows"
}

Headers

CONFIDENT_API_KEYstringRequired
The API key of your Confident AI project.

Path parameters

aliasstringRequired
The unique alias of the dataset.
datasetIngestionTaskIdstringRequired
The unique identifier of the ingestion task.

Request body

descriptionstring
A note about what the task harvests.
enabledboolean
Whether the task runs. Disabling it unschedules the job; goldens already created are kept.
sampleRatenumber
The fraction of matching items to ingest. Defaults to 1 (all of them).
filtersobject
A set of filter groups combined by a top-level operator.
Show 2 propertiesHide 2 properties
- operatorenumRequired
  How filters or groups are combined.
  Show 2 enum valuesHide 2 enum values
  - AND
  - OR
- groupslist of objectsRequired
  The filter groups.
  Show 2 propertiesHide 2 properties
  - operatorenumRequired
    How filters or groups are combined.
    Show 2 enum valuesHide 2 enum values
    AND
    OR
  - filterslist of objectsRequired
    The filter rows in this group.
    Show 4 propertiesHide 4 properties
    categorystringRequired
    The property a filter row matches on (e.g. "Name", "User Id", "Model", "Metadata"). The set of valid values depends on the line's dataModel.
    conditionenumRequired
    The comparison a filter row applies. Valid conditions depend on the category.
    Show 18 enum valuesHide 18 enum values
    Is
    Is not
    Is equal to
    Does not equal
    Is less than
    Is equal or less than
    Is greater than
    Is equal or greater than
    Has
    Has not
    Contains
    Contains only
    Does not contain
    Has increased by more than
    Has increased by less than
    Has decreased by more than
    Has decreased by less than
    Has changed from
    valuestring | number | list of stringsRequired
    The value to match against.
    Show 3 variantsHide 3 variants
    string
    OR
    number
    OR
    list of strings
    keystring
    The property key. Auto-populated from category when omitted; required for Metadata, Metric, and Classifier filters.
maxGoldensinteger
The maximum number of goldens this task will ever create. Send null to remove the cap.
inputTransformerIdstring
A transformer that reshapes the harvested input before it is stored. Send null to detach it.
outputTransformerIdstring
A transformer that reshapes the harvested output before it is stored. Send null to detach it.
includeInputboolean
Populate the golden's input from the harvested item. Defaults to true; every other include flag defaults to false.
includeActualOutputboolean
Populate the golden's actualOutput.
includeExpectedOutputboolean
Populate the golden's expectedOutput.
includeRetrievalContextboolean
Populate the golden's retrievalContext.
includeContextboolean
Populate the golden's context.
includeToolsCalledboolean
Populate the golden's toolsCalled.
includeExpectedToolsboolean
Populate the golden's expectedTools.
namestring
A new name for the task, unique within the dataset.
dataModelenum
What kind of item to harvest. Must still match the dataset's type.
Show 3 enum valuesHide 3 enum values
- TRACE
- SPAN
- THREAD

Response

successboolean
Indicates if the request was successful.
dataobject
Show 1 propertyHide 1 property
- datasetIngestionTaskobject
  Show 18 propertiesHide 18 properties
  - idstring
    The unique identifier of the ingestion task.
  - namestring
    The name of the ingestion task.
  - dataModelenum
    What kind of item the task harvests.
    Show 3 enum valuesHide 3 enum values
    TRACE
    SPAN
    THREAD
  - goldensCountinteger
    How many goldens this task has created so far.
  - descriptionstring
    A note about what the task harvests.
  - enabledboolean
    Whether the task runs. Disabling it unschedules the job; goldens already created are kept.
  - sampleRatenumber
    The fraction of matching items to ingest. Defaults to 1 (all of them).
  - filtersobject
    A set of filter groups combined by a top-level operator.
    Show 2 propertiesHide 2 properties
    operatorenum
    How filters or groups are combined.
    Show 2 enum valuesHide 2 enum values
    AND
    OR
    groupslist of objects
    The filter groups.
    Show 2 propertiesHide 2 properties
    operatorenum
    How filters or groups are combined.
    Show 2 enum valuesHide 2 enum values
    AND
    OR
    filterslist of objects
    The filter rows in this group.
    Show 4 propertiesHide 4 properties
    categorystring
    The property a filter row matches on (e.g. "Name", "User Id", "Model", "Metadata"). The set of valid values depends on the line's dataModel.
    conditionenum
    The comparison a filter row applies. Valid conditions depend on the category.
    Show 18 enum valuesHide 18 enum values
    Is
    Is not
    Is equal to
    Does not equal
    Is less than
    Is equal or less than
    Is greater than
    Is equal or greater than
    Has
    Has not
    Contains
    Contains only
    Does not contain
    Has increased by more than
    Has increased by less than
    Has decreased by more than
    Has decreased by less than
    Has changed from
    valuestring | number | list of strings
    The value to match against.
    keystring
    The property key. Auto-populated from category when omitted; required for Metadata, Metric, and Classifier filters.
  - maxGoldensinteger
    The maximum number of goldens this task will ever create. Send null to remove the cap.
  - inputTransformerIdstring
    A transformer that reshapes the harvested input before it is stored. Send null to detach it.
  - outputTransformerIdstring
    A transformer that reshapes the harvested output before it is stored. Send null to detach it.
  - includeInputboolean
    Populate the golden's input from the harvested item. Defaults to true; every other include flag defaults to false.
  - includeActualOutputboolean
    Populate the golden's actualOutput.
  - includeExpectedOutputboolean
    Populate the golden's expectedOutput.
  - includeRetrievalContextboolean
    Populate the golden's retrievalContext.
  - includeContextboolean
    Populate the golden's context.
  - includeToolsCalledboolean
    Populate the golden's toolsCalled.
  - includeExpectedToolsboolean
    Populate the golden's expectedTools.
linkstring
A link to the workflows page.

Built byConfident AI