Share via


ImageBasedHostedAgentDefinition Class

Definition

The image-based deployment definition for a hosted agent.

public class ImageBasedHostedAgentDefinition : Azure.AI.Projects.OpenAI.HostedAgentDefinition, System.ClientModel.Primitives.IJsonModel<Azure.AI.Projects.OpenAI.ImageBasedHostedAgentDefinition>, System.ClientModel.Primitives.IPersistableModel<Azure.AI.Projects.OpenAI.ImageBasedHostedAgentDefinition>
type ImageBasedHostedAgentDefinition = class
    inherit HostedAgentDefinition
    interface IJsonModel<ImageBasedHostedAgentDefinition>
    interface IPersistableModel<ImageBasedHostedAgentDefinition>
Public Class ImageBasedHostedAgentDefinition
Inherits HostedAgentDefinition
Implements IJsonModel(Of ImageBasedHostedAgentDefinition), IPersistableModel(Of ImageBasedHostedAgentDefinition)
Inheritance
ImageBasedHostedAgentDefinition
Implements

Constructors

Name Description
ImageBasedHostedAgentDefinition(IEnumerable<ProtocolVersionRecord>, String, String, String)

Initializes a new instance of ImageBasedHostedAgentDefinition.

Properties

Name Description
ContainerProtocolVersions

The protocols that the agent supports for ingress communication of the containers.

(Inherited from HostedAgentDefinition)
ContentFilterConfiguration

Configuration for Responsible AI (RAI) content filtering and safety features.

(Inherited from AgentDefinition)
Cpu

The CPU configuration for the hosted agent.

(Inherited from HostedAgentDefinition)
EnvironmentVariables

Environment variables to set in the hosted agent container.

(Inherited from HostedAgentDefinition)
Image

The image for the hosted agent.

Memory

The memory configuration for the hosted agent.

(Inherited from HostedAgentDefinition)
Tools

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.

(Inherited from HostedAgentDefinition)

Methods

Name Description
JsonModelCreateCore(Utf8JsonReader, ModelReaderWriterOptions)
JsonModelWriteCore(Utf8JsonWriter, ModelReaderWriterOptions)
PersistableModelCreateCore(BinaryData, ModelReaderWriterOptions)
PersistableModelWriteCore(ModelReaderWriterOptions)

Explicit Interface Implementations

Name Description
IJsonModel<AgentDefinition>.Create(Utf8JsonReader, ModelReaderWriterOptions) (Inherited from AgentDefinition)
IJsonModel<AgentDefinition>.Write(Utf8JsonWriter, ModelReaderWriterOptions) (Inherited from AgentDefinition)
IJsonModel<HostedAgentDefinition>.Create(Utf8JsonReader, ModelReaderWriterOptions) (Inherited from HostedAgentDefinition)
IJsonModel<HostedAgentDefinition>.Write(Utf8JsonWriter, ModelReaderWriterOptions) (Inherited from HostedAgentDefinition)
IJsonModel<ImageBasedHostedAgentDefinition>.Create(Utf8JsonReader, ModelReaderWriterOptions)
IJsonModel<ImageBasedHostedAgentDefinition>.Write(Utf8JsonWriter, ModelReaderWriterOptions)
IPersistableModel<AgentDefinition>.Create(BinaryData, ModelReaderWriterOptions) (Inherited from AgentDefinition)
IPersistableModel<AgentDefinition>.GetFormatFromOptions(ModelReaderWriterOptions) (Inherited from AgentDefinition)
IPersistableModel<AgentDefinition>.Write(ModelReaderWriterOptions) (Inherited from AgentDefinition)
IPersistableModel<HostedAgentDefinition>.Create(BinaryData, ModelReaderWriterOptions) (Inherited from HostedAgentDefinition)
IPersistableModel<HostedAgentDefinition>.GetFormatFromOptions(ModelReaderWriterOptions) (Inherited from HostedAgentDefinition)
IPersistableModel<HostedAgentDefinition>.Write(ModelReaderWriterOptions) (Inherited from HostedAgentDefinition)
IPersistableModel<ImageBasedHostedAgentDefinition>.Create(BinaryData, ModelReaderWriterOptions)
IPersistableModel<ImageBasedHostedAgentDefinition>.GetFormatFromOptions(ModelReaderWriterOptions)
IPersistableModel<ImageBasedHostedAgentDefinition>.Write(ModelReaderWriterOptions)

Applies to