Condividi tramite

BetaToolboxesOperations Class

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through

AIProjectClient's

<xref:toolboxes> attribute.

Constructor

BetaToolboxesOperations(*args, **kwargs)

Methods

create_version

Create a new version of a toolbox. If the toolbox does not exist, it will be created.
delete

Delete a toolbox and all its versions.
delete_version

Delete a specific version of a toolbox.
get

Retrieve a toolbox.
get_version

Retrieve a specific version of a toolbox.
list

List all toolboxes.
list_versions

List all versions of a toolbox.
update

Update a toolbox to point to a specific version.

create_version

Create a new version of a toolbox. If the toolbox does not exist, it will be created.

async create_version(name: str, *, tools: List[_models.Tool], content_type: str = 'application/json', description: str | None = None, metadata: dict[str, str] | None = None, policies: _models.ToolboxPolicies | None = None, **kwargs: Any) -> _models.ToolboxVersionObject

Parameters

Name Description
name
Required
str

The name of the toolbox. If the toolbox does not exist, it will be created. Required.
body
<xref:JSON> or IO[bytes]

Is either a JSON type or a IO[bytes] type. Required.

Keyword-Only Parameters

Name Description
tools
list[Tool]

The list of tools to include in this version. Required.

Default value: <object object at 0x00000210BA37F9C0>
description
str

A human-readable description of the toolbox. Default value is None.

Default value: None
metadata
dict[str, str]

Arbitrary key-value metadata to associate with the toolbox. Default value is None.

Default value: None
policies
ToolboxPolicies

Policy configuration for this toolbox version. Default value is None.

Default value: None

Returns

Type Description
ToolboxVersionObject

ToolboxVersionObject. The ToolboxVersionObject is compatible with MutableMapping

Exceptions

Type Description
HttpResponseError

delete

Delete a toolbox and all its versions.

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

Parameters

Name Description
name
Required
str

The name of the toolbox to delete. Required.

Returns

Type Description
None

None

Exceptions

Type Description
HttpResponseError

delete_version

Delete a specific version of a toolbox.

async delete_version(name: str, version: str, **kwargs: Any) -> None

Parameters

Name Description
name
Required
str

The name of the toolbox. Required.
version
Required
str

The version identifier to delete. Required.

Returns

Type Description
None

None

Exceptions

Type Description
HttpResponseError

get

Retrieve a toolbox.

async get(name: str, **kwargs: Any) -> ToolboxObject

Parameters

Name Description
name
Required
str

The name of the toolbox to retrieve. Required.

Returns

Type Description
ToolboxObject

ToolboxObject. The ToolboxObject is compatible with MutableMapping

Exceptions

Type Description
HttpResponseError

get_version

Retrieve a specific version of a toolbox.

async get_version(name: str, version: str, **kwargs: Any) -> ToolboxVersionObject

Parameters

Name Description
name
Required
str

The name of the toolbox. Required.
version
Required
str

The version identifier to retrieve. Required.

Returns

Type Description
ToolboxVersionObject

ToolboxVersionObject. The ToolboxVersionObject is compatible with MutableMapping

Exceptions

Type Description
HttpResponseError

list

List all toolboxes.

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

Keyword-Only Parameters

Name Description
limit
int

A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 20. Default value is None.

Default value: None
order
str or PageOrder

Sort order by the created_at timestamp of the objects. asc for ascending order anddesc for descending order. Known values are: "asc" and "desc". Default value is None.

Default value: None
before
str

A cursor for use in pagination. before is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include before=obj_foo in order to fetch the previous page of the list. Default value is None.

Default value: None

Returns

Type Description
AsyncItemPaged[ToolboxObject]

An iterator like instance of ToolboxObject

Exceptions

Type Description
HttpResponseError

list_versions

List all versions of a toolbox.

list_versions(name: str, *, limit: int | None = None, order: str | PageOrder | None = None, before: str | None = None, **kwargs: Any) -> AsyncItemPaged[ToolboxVersionObject]

Parameters

Name Description
name
Required
str

The name of the toolbox to list versions for. Required.

Keyword-Only Parameters

Name Description
limit
int

A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 20. Default value is None.

Default value: None
order
str or PageOrder

Sort order by the created_at timestamp of the objects. asc for ascending order anddesc for descending order. Known values are: "asc" and "desc". Default value is None.

Default value: None
before
str

A cursor for use in pagination. before is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include before=obj_foo in order to fetch the previous page of the list. Default value is None.

Default value: None

Returns

Type Description
AsyncItemPaged[ToolboxVersionObject]

An iterator like instance of ToolboxVersionObject

Exceptions

Type Description
HttpResponseError

update

Update a toolbox to point to a specific version.

async update(name: str, *, default_version: str, content_type: str = 'application/json', **kwargs: Any) -> _models.ToolboxObject

Parameters

Name Description
name
Required
str

The name of the toolbox to update. Required.
body
<xref:JSON> or IO[bytes]

Is either a JSON type or a IO[bytes] type. Required.

Keyword-Only Parameters

Name Description
default_version
str

The version identifier that the toolbox should point to. When set, the toolbox's default version will resolve to this version instead of the latest. Required.

Default value: <object object at 0x00000210BA37F9C0>

Returns

Type Description
ToolboxObject

ToolboxObject. The ToolboxObject is compatible with MutableMapping

Exceptions

Type Description
HttpResponseError