AIClientModelFactory.Agent Method

Definition

Namespace:

Azure.AI.Projects

Assembly:

Azure.AI.Projects.dll

Package:

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

Source:

AIClientModelFactory.cs

Initializes a new instance of Agent.

public static Azure.AI.Projects.Agent Agent (string id = default, DateTimeOffset createdAt = default, string name = default, string description = default, string model = 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);

static member Agent : string * DateTimeOffset * string * string * string * string * seq<Azure.AI.Projects.ToolDefinition> * Azure.AI.Projects.ToolResources * Nullable<single> * Nullable<single> * BinaryData * System.Collections.Generic.IReadOnlyDictionary<string, string> -> Azure.AI.Projects.Agent

Public Shared Function Agent (Optional id As String = Nothing, Optional createdAt As DateTimeOffset = Nothing, Optional name As String = Nothing, Optional description As String = Nothing, Optional model 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) As Agent

Parameters

id

String

The identifier, which can be referenced in API endpoints.

createdAt

DateTimeOffset

The Unix timestamp, in seconds, representing when this object was created.

name

String

The name of the agent.

description

String

The description of the agent.

model

String

The ID of the model to use.

instructions

String

The system instructions for the agent to use.

tools

IEnumerable<ToolDefinition>

The collection of tools enabled for the agent. Please note ToolDefinition is the base class. According to the scenario, a derived class of the base class might need to be assigned here, or this property needs to be casted to one of the possible derived classes. The available derived classes include CodeInterpreterToolDefinition, FileSearchToolDefinition and FunctionToolDefinition.

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.

Returns

Agent