BetaRoutinesOperations Class

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through

AIProjectClient's

<xref:routines> attribute.

Constructor

BetaRoutinesOperations(*args, **kwargs)

Methods

create_or_update	Create or update a routine.
delete	Delete a routine.
disable	Disable a routine.
dispatch	Queue an asynchronous routine dispatch.
enable	Enable a routine.
get	Retrieve a routine.
list	List routines.
list_runs	List prior runs for a routine.

create_or_update

Create or update a routine.

create_or_update(routine_name: str, *, content_type: str = 'application/json', description: str | None = None, enabled: bool | None = None, triggers: dict[str, _models.RoutineTrigger] | None = None, action: _models.RoutineAction | None = None, **kwargs: Any) -> _models.Routine

Parameters

Name	Description
routine_name Required	str The unique name of the routine. Required.
body	<xref:JSON> or IO[bytes] Is either a JSON type or a IO[bytes] type. Required.

Keyword-Only Parameters

Name	Description
description	str A human-readable description of the routine. Default value is None. Default value: None
enabled	bool Whether the routine is enabled. Default value is None. Default value: None
triggers	dict[str, RoutineTrigger] The triggers configured for the routine. In v1, exactly one trigger entry is supported. Default value is None. Default value: None
action	RoutineAction The action executed when the routine fires. Default value is None. Default value: None

Returns

Type	Description
Routine	Routine. The Routine is compatible with MutableMapping

Exceptions

Type	Description
HttpResponseError

delete

Delete a routine.

delete(routine_name: str, **kwargs: Any) -> None

Parameters

Name	Description
routine_name Required	str The unique name of the routine. Required.

Returns

Type	Description
None	None

Exceptions

Type	Description
HttpResponseError

disable

Disable a routine.

disable(routine_name: str, **kwargs: Any) -> Routine

Parameters

Name	Description
routine_name Required	str The unique name of the routine. Required.

Returns

Type	Description
Routine	Routine. The Routine is compatible with MutableMapping

Exceptions

Type	Description
HttpResponseError

dispatch

Queue an asynchronous routine dispatch.

dispatch(routine_name: str, *, content_type: str = 'application/json', payload: _models.RoutineDispatchPayload | None = None, **kwargs: Any) -> _models.DispatchRoutineResult

Parameters

Name	Description
routine_name Required	str The unique name of the routine. Required.
body	<xref:JSON> or IO[bytes] Is either a JSON type or a IO[bytes] type. Required.

Keyword-Only Parameters

Name	Description
payload	RoutineDispatchPayload A direct action-input override sent downstream when testing a routine. Default value is None. Default value: None

Returns

Type	Description
DispatchRoutineResult	DispatchRoutineResult. The DispatchRoutineResult is compatible with MutableMapping

Exceptions

Type	Description
HttpResponseError

enable

Enable a routine.

enable(routine_name: str, **kwargs: Any) -> Routine

Parameters

Name	Description
routine_name Required	str The unique name of the routine. Required.

Returns

Type	Description
Routine	Routine. The Routine is compatible with MutableMapping

Exceptions

Type	Description
HttpResponseError

get

Retrieve a routine.

get(routine_name: str, **kwargs: Any) -> Routine

Parameters

Name	Description
routine_name Required	str The unique name of the routine. Required.

Returns

Type	Description
Routine	Routine. The Routine is compatible with MutableMapping

Exceptions

Type	Description
HttpResponseError

list

List routines.

list(*, limit: int | None = None, before: str | None = None, order: str | None = None, **kwargs: Any) -> ItemPaged[Routine]

Keyword-Only Parameters

Name	Description
limit	int The maximum number of routines to return. Default value is None. Default value: None
before	str Unsupported. Reserved for future backward pagination support. Default value is None. Default value: None
order	str The ordering direction. Supported values are asc and desc. Default value is None. Default value: None

Returns

Type	Description
ItemPaged[Routine]	An iterator like instance of Routine

Exceptions

Type	Description
HttpResponseError

list_runs

List prior runs for a routine.

list_runs(routine_name: str, *, filter: str | None = None, limit: int | None = None, before: str | None = None, order: str | None = None, **kwargs: Any) -> ItemPaged[RoutineRun]

Parameters

Name	Description
routine_name Required	str The unique name of the routine. Required.

Keyword-Only Parameters

Name	Description
filter	str An optional MLflow search-runs filter expression applied within the routine's experiment. Default value is None. Default value: None
limit	int The maximum number of runs to return. Default value is None. Default value: None
before	str Unsupported. Reserved for future backward pagination support. Default value is None. Default value: None
order	str The ordering direction. Supported values are asc and desc. Default value is None. Default value: None

Returns

Type	Description
ItemPaged[RoutineRun]	An iterator like instance of RoutineRun

Exceptions

Type	Description
HttpResponseError