Jobs

On this page

Methods

Methods

list_runs

List Job Runs for provided Job Id. Filter the data based on parameters passed in the query

Parameters

job_id

str

required

Job id of the application

limit

typing.Optional[int]

Number of items per page

offset

typing.Optional[int]

Number of items to skip

search_prefix

typing.Optional[str]

Prefix used to search for job runs by name or identifier

sort_by

typing.Optional[JobRunsSortBy]

Attribute to sort byType Details: JobRunsSortBy

order

typing.Optional[JobRunsSortDirection]

Sorting orderType Details: JobRunsSortDirection

triggered_by

typing.Optional[typing.Union[str, typing.Sequence[str]]]

Array of subject slugs

status

typing.Optional[typing.Union[JobRunStatus, typing.Sequence[JobRunStatus]]]

Status of the job runType Details: JobRunStatus

Returns

Returns all runs of a Job sorted by creation date in “data” key and total count in “totalCount” keyType Details: JobRun

Usage

from truefoundry import TrueFoundry

client = TrueFoundry(
    api_key="YOUR_API_KEY",
    base_url="https://yourhost.com/path/to/api",
)

client.list_runs(
    job_id="value",
    limit=10,
    offset=10,
    search_prefix="value",
    sort_by="value",
    order="value",
    triggered_by="value",
    status="value",
)

get_run

Get Job Run for provided jobRunName and jobId

Parameters

job_id

str

required

Application Id of JOB

job_run_name

str

required

Job run name of the application

Returns

GetJobRunResponse

Return JobRun details of the provided jobRunNameType Details: GetJobRunResponse

Usage

from truefoundry import TrueFoundry

client = TrueFoundry(
    api_key="YOUR_API_KEY",
    base_url="https://yourhost.com/path/to/api",
)

client.get_run(
    job_id="value",
    job_run_name="value",
)

delete_run

Delete Job Run for provided jobRunName and jobId

Parameters

job_id

str

required

Application Id of JOB

job_run_name

str

required

Job run name of the application

Returns

DeleteJobRunResponse

Job Run deletedType Details: DeleteJobRunResponse

Usage

from truefoundry import TrueFoundry

client = TrueFoundry(
    api_key="YOUR_API_KEY",
    base_url="https://yourhost.com/path/to/api",
)

client.delete_run(
    job_id="value",
    job_run_name="value",
)

trigger

Trigger Job for provided deploymentId or applicationId

Parameters

deployment_id

typing.Optional[str]

Deployment Id of the job

application_id

typing.Optional[str]

Application Id of the job

input

typing.Optional[TriggerJobRequestInput]

Job trigger inputType Details: TriggerJobRequestInput

Returns

TriggerJobRunResponse

Returns object with message, JobRun Name And Job Details on successful creation of JobType Details: TriggerJobRunResponse

Usage

from truefoundry import TrueFoundry

client = TrueFoundry(
    api_key="YOUR_API_KEY",
    base_url="https://yourhost.com/path/to/api",
)

client.trigger(
    deployment_id="value",
    application_id="application_id_value",
    input="value",
)

terminate

Terminate Job for provided deploymentId and jobRunName

Parameters

deployment_id

str

required

Deployment Id of the Deployment

job_run_name

str

required

Job Run name

Returns

TerminateJobResponse

Returns object with message and JobRun Status on successful termination of JobType Details: TerminateJobResponse

Usage

from truefoundry import TrueFoundry

client = TrueFoundry(
    api_key="YOUR_API_KEY",
    base_url="https://yourhost.com/path/to/api",
)

client.terminate(
    deployment_id="value",
    job_run_name="value",
)

TrueFoundry SDK

Clusters

Workspaces

MLRepos

Applications

Models

Artifacts

Prompts

Secret Groups

Secrets

Model Deployments

Users

Teams

Personal Access Tokens

Virtual Accounts

Logs

Audit Logs

Apply

Jobs

Methods

Parameters

Returns

Usage

Parameters

Returns

Usage

Parameters

Returns

Usage

Parameters

Returns

Usage

Parameters

Returns

Usage

TrueFoundry SDK

Clusters

Workspaces

MLRepos

Applications

Jobs

Models

Artifacts

Prompts

Secret Groups

Secrets

Model Deployments

Users

Teams

Personal Access Tokens

Virtual Accounts

Logs

Audit Logs

Apply

​Methods

Methods