AgentsClient.CreateAgent Method

Definition

Namespace:

Azure.AI.Projects

Assembly:

Azure.AI.Projects.dll

Package:

Azure.AI.Projects v1.0.0-beta.1

Overloads

CreateAgent(RequestContent, RequestContext)

[Protocol Method] Creates a new agent. This protocol method allows explicit creation of the request and processing of the response for advanced scenarios. Please try the simpler CreateAgent(String, String, String, String, IEnumerable<ToolDefinition>, ToolResources, Nullable<Single>, Nullable<Single>, BinaryData, IReadOnlyDictionary<String,String>, CancellationToken) convenience overload with strongly typed models first.

CreateAgent(String, String, String, String, IEnumerable<ToolDefinition>, ToolResources, Nullable<Single>, Nullable<Single>, BinaryData, IReadOnlyDictionary<String,String>, CancellationToken)

Creates a new agent.

CreateAgent(RequestContent, RequestContext)

Source:

AgentsClient.cs

[Protocol Method] Creates a new agent.

• This protocol method allows explicit creation of the request and processing of the response for advanced scenarios.
• Please try the simpler CreateAgent(String, String, String, String, IEnumerable<ToolDefinition>, ToolResources, Nullable<Single>, Nullable<Single>, BinaryData, IReadOnlyDictionary<String,String>, CancellationToken) convenience overload with strongly typed models first.

public virtual Azure.Response CreateAgent (Azure.Core.RequestContent content, Azure.RequestContext context = default);

abstract member CreateAgent : Azure.Core.RequestContent * Azure.RequestContext -> Azure.Response
override this.CreateAgent : Azure.Core.RequestContent * Azure.RequestContext -> Azure.Response

Public Overridable Function CreateAgent (content As RequestContent, Optional context As RequestContext = Nothing) As Response

Parameters

content

RequestContent

The content to send as the body of the request.

context

RequestContext

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

Returns

Response

The response returned from the service.

Exceptions

ArgumentNullException

content is null.

RequestFailedException

Service returned a non-success status code.

CreateAgent(String, String, String, String, IEnumerable<ToolDefinition>, ToolResources, Nullable<Single>, Nullable<Single>, BinaryData, IReadOnlyDictionary<String,String>, CancellationToken)

Source:

AgentsClient.cs

Creates a new agent.

public virtual Azure.Response<Azure.AI.Projects.Agent> CreateAgent (string model, string name = default, string description = default, string instructions = default, System.Collections.Generic.IEnumerable<Azure.AI.Projects.ToolDefinition> tools = default, Azure.AI.Projects.ToolResources toolResources = default, float? temperature = default, float? topP = default, BinaryData responseFormat = default, System.Collections.Generic.IReadOnlyDictionary<string,string> metadata = default, System.Threading.CancellationToken cancellationToken = default);

abstract member CreateAgent : string * string * string * string * seq<Azure.AI.Projects.ToolDefinition> * Azure.AI.Projects.ToolResources * Nullable<single> * Nullable<single> * BinaryData * System.Collections.Generic.IReadOnlyDictionary<string, string> * System.Threading.CancellationToken -> Azure.Response<Azure.AI.Projects.Agent>
override this.CreateAgent : string * string * string * string * seq<Azure.AI.Projects.ToolDefinition> * Azure.AI.Projects.ToolResources * Nullable<single> * Nullable<single> * BinaryData * System.Collections.Generic.IReadOnlyDictionary<string, string> * System.Threading.CancellationToken -> Azure.Response<Azure.AI.Projects.Agent>

Public Overridable Function CreateAgent (model As String, Optional name As String = Nothing, Optional description As String = Nothing, Optional instructions As String = Nothing, Optional tools As IEnumerable(Of ToolDefinition) = Nothing, Optional toolResources As ToolResources = Nothing, Optional temperature As Nullable(Of Single) = Nothing, Optional topP As Nullable(Of Single) = Nothing, Optional responseFormat As BinaryData = Nothing, Optional metadata As IReadOnlyDictionary(Of String, String) = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Response(Of Agent)

Parameters

model

String

The ID of the model to use.

name

String

The name of the new agent.

description

String

The description of the new agent.

instructions

String

The system instructions for the new agent to use.

tools

IEnumerable<ToolDefinition>

The collection of tools to enable for the new agent.

toolResources

ToolResources

A set of resources that are used by the agent's tools. The resources are specific to the type of tool. For example, the code_interpreter tool requires a list of file IDs, while the file_search tool requires a list of vector store IDs.

temperature

Nullable<Single>

What sampling temperature to use, between 0 and 2. Higher values like 0.8 will make the output more random, while lower values like 0.2 will make it more focused and deterministic.

topP

Nullable<Single>

An alternative to sampling with temperature, called nucleus sampling, where the model considers the results of the tokens with top_p probability mass. So 0.1 means only the tokens comprising the top 10% probability mass are considered.

We generally recommend altering this or temperature but not both.

responseFormat

BinaryData

The response format of the tool calls used by this agent.

metadata

IReadOnlyDictionary<String,String>

A set of up to 16 key/value pairs that can be attached to an object, used for storing additional information about that object in a structured format. Keys may be up to 64 characters in length and values may be up to 512 characters in length.

cancellationToken

CancellationToken

The cancellation token to use.

Returns

Response<Agent>

Exceptions

ArgumentNullException

model is null.