Skip to content

Task Module

openaivec.task

Prebuilt task factories and registry helpers.

Use function-based task factories from domain modules:

  • openaivec.task.nlp
  • openaivec.task.customer_support
  • openaivec.task.table

Registry helpers provide discoverable task lookup by key.

Migration note (breaking change): - Constant-style task names were removed. - Example: nlp.SENTIMENT_ANALYSIS -> nlp.sentiment_analysis() - Example: customer_support.INTENT_ANALYSIS -> customer_support.intent_analysis()

Classes

TaskSpec dataclass 

TaskSpec(
    key: str,
    domain: str,
    summary: str,
    factory: TaskFactory,
    response_format: type[Any],
)

Specification for a registered task factory.

Functions:

list_tasks 

list_tasks(domain: str | None = None) -> list[str]

Return registered task keys, optionally filtered by domain prefix.

Source code in src/openaivec/task/__init__.py 
35
36
37
def list_tasks(domain: str | None = None) -> list[str]:
    """Return registered task keys, optionally filtered by domain prefix."""
    return [spec.key for spec in list_task_specs(domain=domain)]

get_task_spec 

get_task_spec(key: str) -> TaskSpec

Return the task spec for a registry key.

Source code in src/openaivec/task/__init__.py 
40
41
42
def get_task_spec(key: str) -> TaskSpec:
    """Return the task spec for a registry key."""
    return get_task_spec_or_raise(key)

get_task 

get_task(key: str, **kwargs: Any) -> PreparedTask[Any]

Create a prepared task instance from a registry key.

Source code in src/openaivec/task/__init__.py 
45
46
47
48
def get_task(key: str, **kwargs: Any) -> PreparedTask[Any]:
    """Create a prepared task instance from a registry key."""
    spec = get_task_spec_or_raise(key)
    return spec.factory(**kwargs)