+
+
Dynamically create a MultiTask OpenAISchema that can be used to segment multiple
+tasks given a base class. This creates class that can be used to create a toolkit
+for a specific task, names and descriptions are automatically generated. However
+they can be overridden.
+
+
+ Note
+ Using this function is equivalent to creating a class that inherits from
+OpenAISchema and has a list of the subtask class as a field.
+class MultiTask(OpenAISchema):
+ """
+ Correct segmentation of `{subtask_class.__name__}` tasks
+ """
+ tasks: List[subtask_class] = Field(
+ default_factory=list,
+ repr=False,
+ description=f"Correctly segmented list of `{subtask_class.__name__}` tasks",
+ )
+
+
+
+
Parameters:
+
+
+
+ | Name |
+ Type |
+ Description |
+ Default |
+
+
+
+
+ subtask_class |
+
+ Type[OpenAISchema]
+ |
+
+
+ The base class to use for the MultiTask
+ |
+
+ required
+ |
+
+
+ name |
+
+ Optional[str]
+ |
+
+
+ The name of the MultiTask class, if None then the name
+of the subtask class is used as Multi{subtask_class.__name__}
+ |
+
+ None
+ |
+
+
+ description |
+
+ Optional[str]
+ |
+
+
+ The description of the MultiTask class, if None
+then the description is set to Correct segmentation of{subtask_class.name}tasks
+ |
+
+ None
+ |
+
+
+
+
+
+
+
Returns:
+
+
+
+| Name | Type |
+ Description |
+
+
+
+
+schema |
+ OpenAISchema
+ |
+
+
+ A new class that can be used to segment multiple tasks
+ |
+
+
+
+
+
+ Source code in openai_function_call/dsl/multitask.py
+ | def MultiTask(
+ subtask_class: Type[BaseModel],
+ name: Optional[str] = None,
+ description: Optional[str] = None,
+):
+ """
+ Dynamically create a MultiTask OpenAISchema that can be used to segment multiple
+ tasks given a base class. This creates class that can be used to create a toolkit
+ for a specific task, names and descriptions are automatically generated. However
+ they can be overridden.
+
+ Note:
+ Using this function is equivalent to creating a class that inherits from
+ OpenAISchema and has a list of the subtask class as a field.
+
+ ```python
+ class MultiTask(OpenAISchema):
+ \"""
+ Correct segmentation of `{subtask_class.__name__}` tasks
+ \"""
+ tasks: List[subtask_class] = Field(
+ default_factory=list,
+ repr=False,
+ description=f"Correctly segmented list of `{subtask_class.__name__}` tasks",
+ )
+ ```
+
+ Parameters:
+ subtask_class (Type[OpenAISchema]): The base class to use for the MultiTask
+ name (Optional[str]): The name of the MultiTask class, if None then the name
+ of the subtask class is used as `Multi{subtask_class.__name__}`
+ description (Optional[str]): The description of the MultiTask class, if None
+ then the description is set to `Correct segmentation of `{subtask_class.__name__}` tasks`
+
+ Returns:
+ schema (OpenAISchema): A new class that can be used to segment multiple tasks
+ """
+ task_name = subtask_class.__name__ if name is None else name
+
+ name = f"Multi{task_name}"
+
+ list_tasks = (
+ List[subtask_class],
+ Field(
+ default_factory=list,
+ repr=False,
+ description=f"Correctly segmented list of `{task_name}` tasks",
+ ),
+ )
+
+ new_cls = create_model(
+ name,
+ tasks=list_tasks,
+ __base__=(OpenAISchema, MultiTaskBase),
+ )
+ # set the class constructor BaseModel
+ new_cls.task_type = subtask_class
+
+ new_cls.__doc__ = (
+ f"Correct segmentation of `{task_name}` tasks"
+ if description is None
+ else description
+ )
+
+ return new_cls
+
|
+