queenbee.io.outputs.function module

Queenbee output types for functions.

For more information on plugins see plugin module.

class queenbee.io.outputs.function.FunctionArrayOutput(*, type: ~typing.Literal['FunctionArrayOutput'] = 'FunctionArrayOutput', annotations: ~typing.Dict[str, ~typing.Any] = <factory>, name: str, description: str | None = None, path: str, required: bool = True, items_type: ~queenbee.io.common.ItemType = ItemType.String)

Bases: FunctionStringOutput

Function array output.

This output loads the content from a JSON file which must be a JSON Array.

items_type: ItemType

model_config: ClassVar[ConfigDict] = {}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

type: Literal['FunctionArrayOutput']

class queenbee.io.outputs.function.FunctionBooleanOutput(*, type: ~typing.Literal['FunctionBooleanOutput'] = 'FunctionBooleanOutput', annotations: ~typing.Dict[str, ~typing.Any] = <factory>, name: str, description: str | None = None, path: str, required: bool = True)

Bases: FunctionStringOutput

Function boolean output.

This output loads the content from a file as a boolean.

model_config: ClassVar[ConfigDict] = {}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

type: Literal['FunctionBooleanOutput']

class queenbee.io.outputs.function.FunctionFileOutput(*, type: ~typing.Literal['FunctionFileOutput'] = 'FunctionFileOutput', annotations: ~typing.Dict[str, ~typing.Any] = <factory>, name: str, description: str | None = None, path: str, required: bool = True)

Bases: PathOutput

Function File output.

property is_artifact

model_config: ClassVar[ConfigDict] = {}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

path: str

type: Literal['FunctionFileOutput']

class queenbee.io.outputs.function.FunctionFolderOutput(*, type: ~typing.Literal['FunctionFolderOutput'] = 'FunctionFolderOutput', annotations: ~typing.Dict[str, ~typing.Any] = <factory>, name: str, description: str | None = None, path: str, required: bool = True)

Bases: PathOutput

Function Folder output.

property is_artifact

model_config: ClassVar[ConfigDict] = {}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

path: str

type: Literal['FunctionFolderOutput']

class queenbee.io.outputs.function.FunctionIntegerOutput(*, type: ~typing.Literal['FunctionIntegerOutput'] = 'FunctionIntegerOutput', annotations: ~typing.Dict[str, ~typing.Any] = <factory>, name: str, description: str | None = None, path: str, required: bool = True)

Bases: FunctionStringOutput

Function integer output.

This output loads the content from a file as an integer.

model_config: ClassVar[ConfigDict] = {}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

type: Literal['FunctionIntegerOutput']

class queenbee.io.outputs.function.FunctionJSONObjectOutput(*, type: ~typing.Literal['FunctionJSONObjectOutput'] = 'FunctionJSONObjectOutput', annotations: ~typing.Dict[str, ~typing.Any] = <factory>, name: str, description: str | None = None, path: str, required: bool = True)

Bases: FunctionStringOutput

Function object output.

This output loads the content from a file as a JSON object.

model_config: ClassVar[ConfigDict] = {}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

type: Literal['FunctionJSONObjectOutput']

class queenbee.io.outputs.function.FunctionNumberOutput(*, type: ~typing.Literal['FunctionNumberOutput'] = 'FunctionNumberOutput', annotations: ~typing.Dict[str, ~typing.Any] = <factory>, name: str, description: str | None = None, path: str, required: bool = True)

Bases: FunctionStringOutput

Function number output.

This output loads the content from a file as a floating number.

model_config: ClassVar[ConfigDict] = {}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

type: Literal['FunctionNumberOutput']

class queenbee.io.outputs.function.FunctionPathOutput(*, type: ~typing.Literal['FunctionPathOutput'] = 'FunctionPathOutput', annotations: ~typing.Dict[str, ~typing.Any] = <factory>, name: str, description: str | None = None, path: str, required: bool = True)

Bases: PathOutput

Function Path output.

property is_artifact

model_config: ClassVar[ConfigDict] = {}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

path: str

type: Literal['FunctionPathOutput']

class queenbee.io.outputs.function.FunctionStringOutput(*, type: ~typing.Literal['FunctionStringOutput'] = 'FunctionStringOutput', annotations: ~typing.Dict[str, ~typing.Any] = <factory>, name: str, description: str | None = None, path: str, required: bool = True)

Bases: FunctionFileOutput

Function string output.

This output loads the content from a file as a string.

property is_artifact

model_config: ClassVar[ConfigDict] = {}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

type: Literal['FunctionStringOutput']