ProjectsAgentsModelFactory.HostedAgentDefinition 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.
Overloads
HostedAgentDefinition(ContentFilterConfiguration, IEnumerable<ProjectsAgentTool>, IEnumerable<ProtocolVersionRecord>, String, String, IDictionary<String, String>, String)
The hosted agent definition.
public static Azure.AI.Projects.Agents.HostedAgentDefinition HostedAgentDefinition(Azure.AI.Projects.Agents.ContentFilterConfiguration contentFilterConfiguration = default, System.Collections.Generic.IEnumerable<Azure.AI.Projects.Agents.ProjectsAgentTool> tools = default, System.Collections.Generic.IEnumerable<Azure.AI.Projects.Agents.ProtocolVersionRecord> versions = default, string cpu = default, string memory = default, System.Collections.Generic.IDictionary<string,string> environmentVariables = default, string image = default);static member HostedAgentDefinition : Azure.AI.Projects.Agents.ContentFilterConfiguration * seq<Azure.AI.Projects.Agents.ProjectsAgentTool> * seq<Azure.AI.Projects.Agents.ProtocolVersionRecord> * string * string * System.Collections.Generic.IDictionary<string, string> * string -> Azure.AI.Projects.Agents.HostedAgentDefinitionPublic Shared Function HostedAgentDefinition (Optional contentFilterConfiguration As ContentFilterConfiguration = Nothing, Optional tools As IEnumerable(Of ProjectsAgentTool) = Nothing, Optional versions As IEnumerable(Of ProtocolVersionRecord) = Nothing, Optional cpu As String = Nothing, Optional memory As String = Nothing, Optional environmentVariables As IDictionary(Of String, String) = Nothing, Optional image As String = Nothing) As HostedAgentDefinitionParameters
- contentFilterConfiguration
- ContentFilterConfiguration
Configuration for Responsible AI (RAI) content filtering and safety features.
- tools
- IEnumerable<ProjectsAgentTool>
An array of tools the hosted agent's model may call while generating a response. You
can specify which tool to use by setting the tool_choice parameter.
- versions
- IEnumerable<ProtocolVersionRecord>
The protocols that the agent supports for ingress communication of the containers.
- cpu
- String
The CPU configuration for the hosted agent.
- memory
- String
The memory configuration for the hosted agent.
- environmentVariables
- IDictionary<String,String>
Environment variables to set in the hosted agent container.
- image
- String
The image ID for the agent, applicable to image-based hosted agents.
Returns
A new HostedAgentDefinition instance for mocking.
Applies to
HostedAgentDefinition(ContentFilterConfiguration, String, String, IDictionary<String,String>, ContainerConfiguration, IEnumerable<ProtocolVersionRecord>, CodeConfiguration, TelemetryConfig, SessionConfiguration)
The hosted agent definition.
public static Azure.AI.Projects.Agents.HostedAgentDefinition HostedAgentDefinition(Azure.AI.Projects.Agents.ContentFilterConfiguration contentFilterConfiguration = default, string cpu = default, string memory = default, System.Collections.Generic.IDictionary<string,string> environmentVariables = default, Azure.AI.Projects.Agents.ContainerConfiguration containerConfiguration = default, System.Collections.Generic.IEnumerable<Azure.AI.Projects.Agents.ProtocolVersionRecord> versions = default, Azure.AI.Projects.Agents.CodeConfiguration codeConfiguration = default, Azure.AI.Projects.Agents.TelemetryConfig telemetryConfig = default, Azure.AI.Projects.Agents.SessionConfiguration sessionConfiguration = default);static member HostedAgentDefinition : Azure.AI.Projects.Agents.ContentFilterConfiguration * string * string * System.Collections.Generic.IDictionary<string, string> * Azure.AI.Projects.Agents.ContainerConfiguration * seq<Azure.AI.Projects.Agents.ProtocolVersionRecord> * Azure.AI.Projects.Agents.CodeConfiguration * Azure.AI.Projects.Agents.TelemetryConfig * Azure.AI.Projects.Agents.SessionConfiguration -> Azure.AI.Projects.Agents.HostedAgentDefinitionPublic Shared Function HostedAgentDefinition (Optional contentFilterConfiguration As ContentFilterConfiguration = Nothing, Optional cpu As String = Nothing, Optional memory As String = Nothing, Optional environmentVariables As IDictionary(Of String, String) = Nothing, Optional containerConfiguration As ContainerConfiguration = Nothing, Optional versions As IEnumerable(Of ProtocolVersionRecord) = Nothing, Optional codeConfiguration As CodeConfiguration = Nothing, Optional telemetryConfig As TelemetryConfig = Nothing, Optional sessionConfiguration As SessionConfiguration = Nothing) As HostedAgentDefinitionParameters
- contentFilterConfiguration
- ContentFilterConfiguration
Configuration for Responsible AI (RAI) content filtering and safety features.
- cpu
- String
The CPU configuration for the hosted agent.
- memory
- String
The memory configuration for the hosted agent.
- environmentVariables
- IDictionary<String,String>
Environment variables to set in the hosted agent container.
- containerConfiguration
- ContainerConfiguration
Container-based deployment configuration. Provide this for image-based deployments. Mutually exclusive with code_configuration — the service validates that exactly one is set.
- versions
- IEnumerable<ProtocolVersionRecord>
The protocols that the agent supports for ingress communication.
- codeConfiguration
- CodeConfiguration
Code-based deployment configuration. Provide this for code-based deployments. Mutually exclusive with container_configuration — the service validates that exactly one is set.
- telemetryConfig
- TelemetryConfig
Optional customer-supplied telemetry configuration for exporting container logs, traces, and metrics.
- sessionConfiguration
- SessionConfiguration
Optional session defaults (for example, the idle timeout) applied to sessions created for this agent version.
Returns
A new HostedAgentDefinition instance for mocking.
