flytekitplugins.openai.DownloadJSONFilesTask

class flytekitplugins.openai.DownloadJSONFilesTask(*args, **kwargs)[source]

Methods

compile(ctx, *args, **kwargs)

Generates a node that encapsulates this task in a workflow definition.

Parameters:

ctx (FlyteContext)

Return type:

Tuple[Promise] | Promise | VoidPromise | None

construct_node_metadata()

Used when constructing the node that encapsulates this task as part of a broader workflow definition.

Return type:

NodeMetadata

dispatch_execute(ctx, input_literal_map)

This function is largely similar to the base PythonTask, with the exception that we have to infer the Python interface before executing. Also, we refer to self.task_template rather than just self similar to task classes that derive from the base PythonTask.

Parameters:
Return type:

LiteralMap | DynamicJobSpec

execute(**kwargs)

Rather than running here, send everything to the executor.

Return type:

Any

find_lhs()
Return type:

str

get_command(settings)
Parameters:

settings (SerializationSettings)

Return type:

List[str]

get_config(settings)

Returns the task config as a serializable dictionary. This task config consists of metadata about the custom defined for this task.

Parameters:

settings (SerializationSettings)

Return type:

Dict[str, str]

get_container(settings)

Returns the container definition (if any) that is used to run the task on hosted Flyte.

Parameters:

settings (SerializationSettings)

Return type:

Container

get_custom(settings)[source]

Return additional plugin-specific custom data (if any) as a serializable dictionary.

Parameters:

settings (SerializationSettings)

Return type:

Dict[str, Any]

get_extended_resources(settings)

Returns the extended resources to allocate to the task on hosted Flyte.

Parameters:

settings (SerializationSettings)

Return type:

ExtendedResources | None

get_image(settings)
Parameters:

settings (SerializationSettings)

Return type:

str

get_input_types()

Returns the names and python types as a dictionary for the inputs of this task.

Return type:

Dict[str, type]

get_k8s_pod(settings)

Returns the kubernetes pod definition (if any) that is used to run the task on hosted Flyte.

Parameters:

settings (SerializationSettings)

Return type:

K8sPod | None

get_sql(settings)

Returns the Sql definition (if any) that is used to run the task on hosted Flyte.

Parameters:

settings (SerializationSettings)

Return type:

Sql | None

get_type_for_input_var(k, v)

Returns the python type for an input variable by name.

Parameters:
Return type:

Type[Any]

get_type_for_output_var(k, v)

Returns the python type for the specified output variable by name.

Parameters:
Return type:

Type[Any]

local_execute(ctx, **kwargs)

This function is used only in the local execution path and is responsible for calling dispatch execute. Use this function when calling a task with native values (or Promises containing Flyte literals derived from Python native values).

Parameters:

ctx (FlyteContext)

Return type:

Tuple[Promise] | Promise | VoidPromise | Coroutine | None

local_execution_mode()
Return type:

Mode

post_execute(_, rval)

This function is a stub, just here to keep dispatch_execute compatibility between this class and PythonTask.

Parameters:
Return type:

Any

pre_execute(user_params)

This function is a stub, just here to keep dispatch_execute compatibility between this class and PythonTask.

Parameters:

user_params (ExecutionParameters | None)

Return type:

ExecutionParameters | None

sandbox_execute(ctx, input_literal_map)

Call dispatch_execute, in the context of a local sandbox execution. Not invoked during runtime.

Parameters:
Return type:

LiteralMap

serialize_to_model(settings)
Parameters:

settings (SerializationSettings)

Return type:

TaskTemplate

Attributes

SERIALIZE_SETTINGS = SerializationSettings(image_config=ImageConfig(default_image=Image(name='custom_container_task', fqn='flyteorg.io/placeholder', tag='image', digest=None), images=None), project='PLACEHOLDER_PROJECT', domain='LOCAL', version='PLACEHOLDER_VERSION', env=None, git_repo=None, python_interpreter='/opt/venv/bin/python3', flytekit_virtualenv_root='/opt/venv', fast_serialization_settings=None, source_root=None)
container_image
disable_deck

If true, this task will not output deck html file

docs
environment

Any environment variables that supplied during the execution of the task.

executor
executor_type
instantiated_in
interface
lhs
location
metadata
name

Return the name of the underlying task.

python_interface

Returns this task’s python interface.

resources
security_context
task_config

Returns the user-specified task config which is used for plugin-specific handling of the task.

task_resolver
task_template

Override the base class implementation to serialize on first call.

task_type
task_type_version