ProjectAgentSkills.GetSkillContentAsync Method

Definition

Namespace:

Azure.AI.Projects.Agents

Assembly:

Azure.AI.Projects.Agents.dll

Package:

Azure.AI.Projects.Agents v2.1.0-beta.4

Overloads

Name	Description
GetSkillContentAsync(String, RequestOptions)	[Protocol Method] Downloads the zip content for the default version of a skill. This protocol method allows explicit creation of the request and processing of the response for advanced scenarios.
GetSkillContentAsync(String, CancellationToken)	Downloads the zip content for the default version of a skill.
GetSkillContentAsync(String, String, CancellationToken)	Downloads a skill package, save it to file and return as a Binary data.

GetSkillContentAsync(String, RequestOptions)

Source:

ProjectAgentSkills.cs

[Protocol Method] Downloads the zip content for the default version of a skill.

• This protocol method allows explicit creation of the request and processing of the response for advanced scenarios.

public virtual System.Threading.Tasks.Task<System.ClientModel.ClientResult> GetSkillContentAsync(string name, System.ClientModel.Primitives.RequestOptions options);

abstract member GetSkillContentAsync : string * System.ClientModel.Primitives.RequestOptions -> System.Threading.Tasks.Task<System.ClientModel.ClientResult>
override this.GetSkillContentAsync : string * System.ClientModel.Primitives.RequestOptions -> System.Threading.Tasks.Task<System.ClientModel.ClientResult>

Public Overridable Function GetSkillContentAsync (name As String, options As RequestOptions) As Task(Of ClientResult)

Parameters

name

String

The name of the skill.

options

RequestOptions

The request options, which can override default behaviors of the client pipeline on a per-call basis.

Returns

Task<ClientResult>

The response returned from the service.

Exceptions

ArgumentNullException

name is null.

ArgumentException

name is an empty string, and was expected to be non-empty.

ClientResultException

Service returned a non-success status code.

GetSkillContentAsync(String, CancellationToken)

Source:

ProjectAgentSkills.cs

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

public virtual System.Threading.Tasks.Task<System.ClientModel.ClientResult<BinaryData>> GetSkillContentAsync(string name, System.Threading.CancellationToken cancellationToken = default);

abstract member GetSkillContentAsync : string * System.Threading.CancellationToken -> System.Threading.Tasks.Task<System.ClientModel.ClientResult<BinaryData>>
override this.GetSkillContentAsync : string * System.Threading.CancellationToken -> System.Threading.Tasks.Task<System.ClientModel.ClientResult<BinaryData>>

Public Overridable Function GetSkillContentAsync (name As String, Optional cancellationToken As CancellationToken = Nothing) As Task(Of ClientResult(Of BinaryData))

Parameters

name

String

The name of the skill.

cancellationToken

CancellationToken

The cancellation token that can be used to cancel the operation.

Returns

Task<ClientResult<BinaryData>>

Exceptions

ArgumentNullException

name is null.

ArgumentException

name is an empty string, and was expected to be non-empty.

ClientResultException

Service returned a non-success status code.

GetSkillContentAsync(String, String, CancellationToken)

Source:

ProjectAgentSkills.cs

Downloads a skill package, save it to file and return as a Binary data.

public virtual System.Threading.Tasks.Task<System.ClientModel.ClientResult<BinaryData>> GetSkillContentAsync(string skillName, string localPath, System.Threading.CancellationToken cancellationToken = default);

abstract member GetSkillContentAsync : string * string * System.Threading.CancellationToken -> System.Threading.Tasks.Task<System.ClientModel.ClientResult<BinaryData>>
override this.GetSkillContentAsync : string * string * System.Threading.CancellationToken -> System.Threading.Tasks.Task<System.ClientModel.ClientResult<BinaryData>>

Public Overridable Function GetSkillContentAsync (skillName As String, localPath As String, Optional cancellationToken As CancellationToken = Nothing) As Task(Of ClientResult(Of BinaryData))

Parameters

skillName

String

The unique name of the skill.

localPath

String

The path to save the skill content to.

cancellationToken

CancellationToken

The cancellation token that can be used to cancel the operation.

Returns

Task<ClientResult<BinaryData>>

Exceptions

ArgumentNullException

skillName or localPath is null.

ArgumentException

skillName or localPath is an empty string, and was expected to be non-empty.

ClientResultException

Service returned a non-success status code.