Language

ChatClientAgentRunOptions Class

Definition

Provides specialized run options for ChatClientAgent instances, extending the base agent run options with chat-specific configuration.

public sealed class ChatClientAgentRunOptions : Microsoft.Agents.AI.AgentRunOptions
type ChatClientAgentRunOptions = class
    inherit AgentRunOptions
Public NotInheritable Class ChatClientAgentRunOptions
Inherits AgentRunOptions
Inheritance
ChatClientAgentRunOptions

Remarks

This class extends AgentRunOptions to provide additional configuration options that are specific to chat client agents, in particular ChatOptions.

Constructors

Name Description
ChatClientAgentRunOptions(ChatOptions)

Initializes a new instance of the ChatClientAgentRunOptions class.

Properties

Name Description
AdditionalProperties

Gets or sets additional properties associated with these options.

(Inherited from AgentRunOptions)
AllowBackgroundResponses

Gets or sets a value indicating whether the background responses are allowed.

(Inherited from AgentRunOptions)
ChatClientFactory

Gets or sets a factory function that can replace (typically via decorators) the chat client on a per-request basis.

ChatOptions

Gets or sets the chat options to apply to the agent invocation.

ContinuationToken

Gets or sets the continuation token for resuming and getting the result of the agent response identified by this token.

(Inherited from AgentRunOptions)
ResponseFormat

Gets or sets the response format.

(Inherited from AgentRunOptions)

Methods

Name Description
Clone()

Produces a clone of the current AgentRunOptions instance.

Applies to