ProjectsAgentsModelFactory.DeclarativeAgentDefinition Method
Definition
Important
Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
The prompt agent definition.
public static Azure.AI.Projects.Agents.DeclarativeAgentDefinition DeclarativeAgentDefinition(Azure.AI.Projects.Agents.ContentFilterConfiguration contentFilterConfiguration = default, string model = default, string instructions = default, float? temperature = default, float? topP = default, OpenAI.Responses.ResponseReasoningOptions reasoningOptions = default, System.Collections.Generic.IEnumerable<OpenAI.Responses.ResponseTool> tools = default, BinaryData toolChoice = default, OpenAI.Responses.ResponseTextOptions textOptions = default, System.Collections.Generic.IDictionary<string,Azure.AI.Projects.Agents.StructuredInputDefinition> structuredInputs = default);static member DeclarativeAgentDefinition : Azure.AI.Projects.Agents.ContentFilterConfiguration * string * string * Nullable<single> * Nullable<single> * OpenAI.Responses.ResponseReasoningOptions * seq<OpenAI.Responses.ResponseTool> * BinaryData * OpenAI.Responses.ResponseTextOptions * System.Collections.Generic.IDictionary<string, Azure.AI.Projects.Agents.StructuredInputDefinition> -> Azure.AI.Projects.Agents.DeclarativeAgentDefinitionPublic Shared Function DeclarativeAgentDefinition (Optional contentFilterConfiguration As ContentFilterConfiguration = Nothing, Optional model As String = Nothing, Optional instructions As String = Nothing, Optional temperature As Nullable(Of Single) = Nothing, Optional topP As Nullable(Of Single) = Nothing, Optional reasoningOptions As ResponseReasoningOptions = Nothing, Optional tools As IEnumerable(Of ResponseTool) = Nothing, Optional toolChoice As BinaryData = Nothing, Optional textOptions As ResponseTextOptions = Nothing, Optional structuredInputs As IDictionary(Of String, StructuredInputDefinition) = Nothing) As DeclarativeAgentDefinitionParameters
- contentFilterConfiguration
- ContentFilterConfiguration
Configuration for Responsible AI (RAI) content filtering and safety features.
- model
- String
The model deployment to use for this agent.
- instructions
- String
A system (or developer) message inserted into the model's context.
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.
We generally recommend altering this or top_p but not both.
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.
- reasoningOptions
- OpenAI.Responses.ResponseReasoningOptions
- tools
- IEnumerable<OpenAI.Responses.ResponseTool>
An array of tools the model may call while generating a response. You
can specify which tool to use by setting the tool_choice parameter.
- toolChoice
- BinaryData
How the model should select which tool (or tools) to use when generating a response.
See the tools parameter to see how to specify which tools the model can call.
- textOptions
- OpenAI.Responses.ResponseTextOptions
Configuration options for a text response from the model. Can be plain text or structured JSON data.
- structuredInputs
- IDictionary<String,StructuredInputDefinition>
Set of structured inputs that can participate in prompt template substitution or tool argument bindings.
Returns
A new DeclarativeAgentDefinition instance for mocking.
