beta_skills

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

Overview

Name	beta_skills
Type	Resource
Id	azure.ai_projects.beta_skills

Fields

The following fields are returned by SELECT queries:

get_version

Name	Datatype	Description
id	string	The unique identifier of the skill version. Required.
name	string	The name of the skill version. Required.
skill_id	string	The identifier of the parent skill. Required.
created_at	string (date-time)	The Unix timestamp (seconds) when the skill version was created. Required.
description	string	A human-readable description of the skill version. Required.
version	string	The version identifier. Skill versions are immutable. Required.

get

Name	Datatype	Description
id	string	The unique identifier of the skill. Required.
name	string	The unique name of the skill. Required.
created_at	string (date-time)	The Unix timestamp (seconds) when the skill was created. Required.
default_version	string	The default version for the skill. Can be changed via updateSkill. Required.
description	string	A human-readable description of the skill. Required.
latest_version	string	The latest version for the skill. Required.

list

Name	Datatype	Description
id	string	The unique identifier of the skill. Required.
name	string	The unique name of the skill. Required.
created_at	string (date-time)	The Unix timestamp (seconds) when the skill was created. Required.
default_version	string	The default version for the skill. Can be changed via updateSkill. Required.
description	string	A human-readable description of the skill. Required.
latest_version	string	The latest version for the skill. 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 skill. Retrieves the specified version of a skill by name and version identifier.
get	select	name, endpoint		Retrieve a skill. Retrieves the specified skill and its current configuration.
list	select	endpoint	limit, order, after, before	List skills. Returns the skills available in the current project.
create	insert	name, endpoint		Create a new version of a skill. Creates a new version of a skill. If the skill does not exist, it will be created.
delete	delete	name, endpoint		Delete a skill. Removes the specified skill and its associated versions.
update	exec	name, endpoint		Update a skill. Modifies the specified skill's configuration.
list_versions	exec	name, endpoint	limit, order, after, before	List skill versions. Returns the available versions for the specified skill.
delete_version	exec	name, version, endpoint		Delete a specific version of a skill. Removes the specified version of a skill.
download	exec	name, endpoint		Download the zip content for the default version of a skill. Downloads the zip content for the default version of a skill.
download_version	exec	name, version, endpoint		Download the zip content for a specific version of a skill. Downloads the zip content for a specific version of a skill.

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 skill. Required.
version	string	The version to download content for. 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 skill. Retrieves the specified version of a skill by name and version identifier.

SELECT
id,
name,
skill_id,
created_at,
description,
version
FROM azure.ai_projects.beta_skills
WHERE name = '{{ name }}' -- required
AND version = '{{ version }}' -- required
AND endpoint = '{{ endpoint }}' -- required
;

get

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

SELECT
id,
name,
created_at,
default_version,
description,
latest_version
FROM azure.ai_projects.beta_skills
WHERE name = '{{ name }}' -- required
AND endpoint = '{{ endpoint }}' -- required
;

list

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

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

INSERT examples

create

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

INSERT INTO azure.ai_projects.beta_skills (
name,
endpoint
)
SELECT 
'{{ name }}',
'{{ endpoint }}'
RETURNING
id,
name,
skill_id,
created_at,
description,
version
;

Manifest

# Description fields are for documentation purposes
- name: beta_skills
props:
  - name: name
    value: "{{ name }}"
    description: Required parameter for the beta_skills resource.
  - name: endpoint
    value: "{{ endpoint }}"
    description: Required parameter for the beta_skills resource.

DELETE examples

delete

Delete a skill. Removes the specified skill and its associated versions.

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

Lifecycle Methods

update

Update a skill. Modifies the specified skill's configuration.

EXEC azure.ai_projects.beta_skills.update 
@name='{{ name }}' --required, 
@endpoint='{{ endpoint }}' --required
;

list_versions

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

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

delete_version

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

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

download

Download the zip content for the default version of a skill. Downloads the zip content for the default version of a skill.

EXEC azure.ai_projects.beta_skills.download 
@name='{{ name }}' --required, 
@endpoint='{{ endpoint }}' --required
;

download_version

Download the zip content for a specific version of a skill. Downloads the zip content for a specific version of a skill.

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