Skip to main content

Data Augmentation Agents: Automate Tasks for Better Search Performance

Enhance your Knowledge Box's performance and precision by running automated agents.

Available Task Names​

Below is a list of task names you can use:

  • LABELER: Automatically apply labels to text blocks or resources based on provided descriptions and examples.
  • LLM_GRAPH: Extract relationships and entities to generate a Knowledge Graph using a large language model (LLM). Dashboard label: Graph Extraction
  • SYNTHETIC_QUESTIONS: Create questions and answers derived from your documents. Dashboard label: Generator
  • ASK: Directly ask questions from your documents to generate questions and answers. Dashboard label: Generate Questions & Answers
  • SEMANTIC_MODEL_MIGRATOR: Recompute vectors for a new semantic model and send the updated data back to NucliaDB for ingestion.
  • LLAMA_GUARD: Identify and flag inappropriate content by labeling unsafe text blocks or resources. Dashboard label: Content Safety
  • PROMPT_GUARD: Detect and label content related to jailbreak attempts. Dashboard label: LLM Security

How to Use Tasks​

Create a task​

SDK Example​

from nuclia import sdk
from nuclia_models.worker.tasks import TaskName, ApplyOptions, DataAugmentation
from nuclia_models.worker.proto import ApplyTo, Filter, LLMConfig, Operation

kb = sdk.NucliaKB()
kb.task.start(
    task_name=TaskName.LABELER,
    apply=ApplyOptions.EXISTING,
    parameters=DataAugmentation(
        name="test",
        on=ApplyTo.FIELD,
        filter=Filter(),
        operations=[Operation()],
        llm=LLMConfig(),
    ),
)

CLI Example​

nuclia kb task start --task_name=labeler --apply=existing --parameters='{
    "name": "test",
    "on": 1,
    "filter": {},
    "operations": [
        {}
    ],
    "llm": {}
}'

List all tasks​

SDK Example​

from nuclia import sdk

kb = sdk.NucliaKB()
kb.task.list()

CLI Example​

nuclia kb task list

Get a task​

SDK Example​

from nuclia import sdk

kb = sdk.NucliaKB()
kb.task.get(task_id="71018fb9-053e-4ca0-9d89-226ada9598e6")

CLI Example​

nuclia kb task get --task_id=71018fb9-053e-4ca0-9d89-226ada9598e6

Stop a task​

SDK Example​

from nuclia import sdk

kb = sdk.NucliaKB()
kb.task.stop(task_id="71018fb9-053e-4ca0-9d89-226ada9598e6")

CLI Example​

nuclia kb task stop --task_id=71018fb9-053e-4ca0-9d89-226ada9598e6

Restart a task​

SDK Example​

from nuclia import sdk

kb = sdk.NucliaKB()
kb.task.restart(task_id="71018fb9-053e-4ca0-9d89-226ada9598e6")

CLI Example​

nuclia kb task restart --task_id=71018fb9-053e-4ca0-9d89-226ada9598e6

Delete a task​

SDK Example​

from nuclia import sdk

kb = sdk.NucliaKB()
kb.task.delete(task_id="71018fb9-053e-4ca0-9d89-226ada9598e6")

CLI Example​

nuclia kb task delete --task_id=71018fb9-053e-4ca0-9d89-226ada9598e6

Notes​

  • Replace 71018fb9-053e-4ca0-9d89-226ada9598e6 with your actual task_id.
  • Use nuclia kb task <command> to perform operations via the CLI.