mirror of
https://github.com/microsoft/agent-framework.git
synced 2026-06-16 21:04:09 +08:00
westeyandGitHub
3dc14dac79
* Add a CreateAIAgent extension method to IChatClient * Fix unit tests * Add tests with null chat clients to ensure appropriate failure * Switch to similar constructor * Add ChatClientBuilder BuildAgent extensions * Address code review comments.
86 lines
3.9 KiB
C#
86 lines
3.9 KiB
C#
// Copyright (c) Microsoft. All rights reserved.
|
|
|
|
using System;
|
|
using System.Collections.Generic;
|
|
using Microsoft.Extensions.AI;
|
|
using Microsoft.Extensions.Logging;
|
|
using Microsoft.Shared.Diagnostics;
|
|
|
|
namespace Microsoft.Agents.AI.ChatClient;
|
|
|
|
/// <summary>
|
|
/// Provides extension methods for building a <see cref="ChatClientAgent"/> from a <see cref="ChatClientBuilder"/>.
|
|
/// </summary>
|
|
public static class ChatClientBuilderExtensions
|
|
{
|
|
/// <summary>
|
|
/// Build a <see cref="ChatClientAgent"/> from the <see cref="IChatClient"/> pipeline described by this <see cref="ChatClientBuilder"/>.
|
|
/// </summary>
|
|
/// <param name="builder">A builder for creating pipelines of <see cref="IChatClient"/>.</param>
|
|
/// <param name="instructions">
|
|
/// Optional system instructions that guide the agent's behavior. These instructions are provided to the <see cref="IChatClient"/>
|
|
/// with each invocation to establish the agent's role and behavior.
|
|
/// </param>
|
|
/// <param name="name">
|
|
/// Optional name for the agent. This name is used for identification and logging purposes.
|
|
/// </param>
|
|
/// <param name="description">
|
|
/// Optional human-readable description of the agent's purpose and capabilities.
|
|
/// This description can be useful for documentation and agent discovery scenarios.
|
|
/// </param>
|
|
/// <param name="tools">
|
|
/// Optional collection of tools that the agent can invoke during conversations.
|
|
/// These tools augment any tools that may be provided to the agent via <see cref="ChatOptions.Tools"/> when
|
|
/// the agent is run.
|
|
/// </param>
|
|
/// <param name="loggerFactory">
|
|
/// Optional logger factory for creating loggers used by the agent and its components.
|
|
/// </param>
|
|
/// <param name="services">
|
|
/// Optional service provider for resolving dependencies required by AI functions and other agent components.
|
|
/// This is particularly important when using custom tools that require dependency injection.
|
|
/// </param>
|
|
/// <returns>A new <see cref="ChatClientAgent"/> instance.</returns>
|
|
public static ChatClientAgent BuildAIAgent(
|
|
this ChatClientBuilder builder,
|
|
string? instructions = null,
|
|
string? name = null,
|
|
string? description = null,
|
|
IList<AITool>? tools = null,
|
|
ILoggerFactory? loggerFactory = null,
|
|
IServiceProvider? services = null) =>
|
|
Throw.IfNull(builder).Build(services).CreateAIAgent(
|
|
instructions: instructions,
|
|
name: name,
|
|
description: description,
|
|
tools: tools,
|
|
loggerFactory: loggerFactory,
|
|
services: services);
|
|
|
|
/// <summary>
|
|
/// Creates a new <see cref="ChatClientAgent"/> instance.
|
|
/// </summary>
|
|
/// <param name="builder">A builder for creating pipelines of <see cref="IChatClient"/>.</param>
|
|
/// <param name="options">
|
|
/// Configuration options that control all aspects of the agent's behavior, including chat settings,
|
|
/// message store factories, context provider factories, and other advanced configurations.
|
|
/// </param>
|
|
/// <param name="loggerFactory">
|
|
/// Optional logger factory for creating loggers used by the agent and its components.
|
|
/// </param>
|
|
/// <param name="services">
|
|
/// Optional service provider for resolving dependencies required by AI functions and other agent components.
|
|
/// This is particularly important when using custom tools that require dependency injection.
|
|
/// </param>
|
|
/// <returns>A new <see cref="ChatClientAgent"/> instance.</returns>
|
|
public static ChatClientAgent BuildAIAgent(
|
|
this ChatClientBuilder builder,
|
|
ChatClientAgentOptions? options,
|
|
ILoggerFactory? loggerFactory = null,
|
|
IServiceProvider? services = null) =>
|
|
Throw.IfNull(builder).Build(services).CreateAIAgent(
|
|
options: options,
|
|
loggerFactory: loggerFactory,
|
|
services: services);
|
|
}
|