toolboxes

Creates, updates, deletes, gets or lists a toolboxes resource.

Overview

Name	toolboxes
Type	Resource
Id	azure.ai_projects.toolboxes

Fields

The following fields are returned by SELECT queries:

get_version

Name	Datatype	Description
id	string	The unique identifier of the toolbox version. Required.
name	string	The name of the toolbox. Required.
created_at	string (date-time)	The Unix timestamp (seconds) when the toolbox version was created. Required.
description	string	A human-readable description of the toolbox.
metadata	object	Set of 16 key-value pairs that can be attached to an object. This can be useful for storing additional information about the object in a structured format, and querying for objects via API or the dashboard. Keys are strings with a maximum length of 64 characters. Values are strings with a maximum length of 512 characters. Required.
policies	object	Policy configuration for the toolbox version.
skills	array	The list of skill sources included in this toolbox version.
tools	array	The list of tools contained in this toolbox version. Required.
version	string	The version identifier of the toolbox. Toolbox versions are immutable and every update creates a new version. Required.

get

Name	Datatype	Description
id	string	The unique identifier of the toolbox. Required.
name	string	The name of the toolbox. Required.
default_version	string	The version identifier that the toolbox currently points to. Defaults to the latest version. Can be changed via updateToolbox. Required.

list

Name	Datatype	Description
id	string	The unique identifier of the toolbox. Required.
name	string	The name of the toolbox. Required.
default_version	string	The version identifier that the toolbox currently points to. Defaults to the latest version. Can be changed via updateToolbox. Required.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_version	select	name, version, endpoint		Retrieve a specific version of a toolbox. Retrieves the specified version of a toolbox by name and version identifier.
get	select	name, endpoint		Retrieve a toolbox. Retrieves the specified toolbox and its current configuration.
list	select	endpoint	limit, order, after, before	List toolboxes. Returns the toolboxes available in the current project.
update	update	name, endpoint		Update a toolbox to point to a specific version. Updates the toolbox's default version pointer to the specified version.
delete	delete	name, endpoint		Delete a toolbox. Removes the specified toolbox along with all of its versions.
list_versions	exec	name, endpoint	limit, order, after, before	List toolbox versions. Returns the available versions for the specified toolbox.
create_version	exec	name, endpoint		Create a new version of a toolbox. Creates a new toolbox version, provisioning the toolbox itself if it does not already exist.
delete_version	exec	name, version, endpoint		Delete a specific version of a toolbox. Removes the specified version of a toolbox.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
endpoint	string	The service endpoint host (no scheme), e.g. myaccount.table.cosmos.azure.com:443 - value of the client endpoint parameter. (default: )
name	string	The name of the toolbox. Required.
version	string	The version identifier to delete. Required.
after	string
before	string	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.
limit	integer	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.
order	string	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.

SELECT examples

get_version

Retrieve a specific version of a toolbox. Retrieves the specified version of a toolbox by name and version identifier.

SELECT
id,
name,
created_at,
description,
metadata,
policies,
skills,
tools,
version
FROM azure.ai_projects.toolboxes
WHERE name = '{{ name }}' -- required
AND version = '{{ version }}' -- required
AND endpoint = '{{ endpoint }}' -- required
;

get

Retrieve a toolbox. Retrieves the specified toolbox and its current configuration.

SELECT
id,
name,
default_version
FROM azure.ai_projects.toolboxes
WHERE name = '{{ name }}' -- required
AND endpoint = '{{ endpoint }}' -- required
;

list

List toolboxes. Returns the toolboxes available in the current project.

SELECT
id,
name,
default_version
FROM azure.ai_projects.toolboxes
WHERE endpoint = '{{ endpoint }}' -- required
AND limit = '{{ limit }}'
AND order = '{{ order }}'
AND after = '{{ after }}'
AND before = '{{ before }}'
;

UPDATE examples

update

Update a toolbox to point to a specific version. Updates the toolbox's default version pointer to the specified version.

UPDATE azure.ai_projects.toolboxes
SET 
-- No updatable properties
WHERE 
name = '{{ name }}' --required
AND endpoint = '{{ endpoint }}' --required
RETURNING
id,
name,
default_version;

DELETE examples

delete

Delete a toolbox. Removes the specified toolbox along with all of its versions.

DELETE FROM azure.ai_projects.toolboxes
WHERE name = '{{ name }}' --required
AND endpoint = '{{ endpoint }}' --required
;

Lifecycle Methods

list_versions

List toolbox versions. Returns the available versions for the specified toolbox.

EXEC azure.ai_projects.toolboxes.list_versions 
@name='{{ name }}' --required, 
@endpoint='{{ endpoint }}' --required, 
@limit='{{ limit }}', 
@order='{{ order }}', 
@after='{{ after }}', 
@before='{{ before }}'
;

create_version

Create a new version of a toolbox. Creates a new toolbox version, provisioning the toolbox itself if it does not already exist.

EXEC azure.ai_projects.toolboxes.create_version 
@name='{{ name }}' --required, 
@endpoint='{{ endpoint }}' --required
;

delete_version

Delete a specific version of a toolbox. Removes the specified version of a toolbox.

EXEC azure.ai_projects.toolboxes.delete_version 
@name='{{ name }}' --required, 
@version='{{ version }}' --required, 
@endpoint='{{ endpoint }}' --required
;