1.16.14

flytekitplugins.openai.batch.connector

Directory

Classes

Class Description
BatchEndpointConnector
BatchEndpointMetadata
State

Variables

Property Type Description
OPENAI_API_KEY str

flytekitplugins.openai.batch.connector.BatchEndpointConnector 

def BatchEndpointConnector()

Properties

Property Type Description
metadata_type None
task_category None task category that the connector supports

Methods

Method Description
create() Return a resource meta that can be used to get the status of the task.
delete() Delete the task.
get() Return the status of the task, and return the outputs in some cases.
get_logs() Return the metrics for the task.
get_metrics() Return the metrics for the task.

create() 

def create(
    task_template: flytekit.models.task.TaskTemplate,
    inputs: typing.Optional[flytekit.models.literals.LiteralMap],
    kwargs,
) -> flytekitplugins.openai.batch.connector.BatchEndpointMetadata

Return a resource meta that can be used to get the status of the task.

Parameter Type Description
task_template flytekit.models.task.TaskTemplate
inputs typing.Optional[flytekit.models.literals.LiteralMap]
kwargs **kwargs

delete() 

def delete(
    resource_meta: flytekitplugins.openai.batch.connector.BatchEndpointMetadata,
    kwargs,
)

Delete the task. This call should be idempotent. It should raise an error if fails to delete the task.

Parameter Type Description
resource_meta flytekitplugins.openai.batch.connector.BatchEndpointMetadata
kwargs **kwargs

get() 

def get(
    resource_meta: flytekitplugins.openai.batch.connector.BatchEndpointMetadata,
    kwargs,
) -> flytekit.extend.backend.base_connector.Resource

Return the status of the task, and return the outputs in some cases. For example, bigquery job can’t write the structured dataset to the output location, so it returns the output literals to the propeller, and the propeller will write the structured dataset to the blob store.

Parameter Type Description
resource_meta flytekitplugins.openai.batch.connector.BatchEndpointMetadata
kwargs **kwargs

get_logs() 

def get_logs(
    resource_meta: flytekit.extend.backend.base_connector.ResourceMeta,
    kwargs,
) -> flyteidl.admin.agent_pb2.GetTaskLogsResponse

Return the metrics for the task.

Parameter Type Description
resource_meta flytekit.extend.backend.base_connector.ResourceMeta
kwargs **kwargs

get_metrics() 

def get_metrics(
    resource_meta: flytekit.extend.backend.base_connector.ResourceMeta,
    kwargs,
) -> flyteidl.admin.agent_pb2.GetTaskMetricsResponse

Return the metrics for the task.

Parameter Type Description
resource_meta flytekit.extend.backend.base_connector.ResourceMeta
kwargs **kwargs

flytekitplugins.openai.batch.connector.BatchEndpointMetadata 

class BatchEndpointMetadata(
    openai_org: str,
    batch_id: str,
)
Parameter Type Description
openai_org str
batch_id str

Methods

Method Description
decode() Decode the resource meta from bytes.
encode() Encode the resource meta to bytes.

decode() 

def decode(
    data: bytes,
) -> BatchEndpointMetadata

Decode the resource meta from bytes.

Parameter Type Description
data bytes

encode() 

def encode()

Encode the resource meta to bytes.

flytekitplugins.openai.batch.connector.State