महत्त्वपूर्ण
Microsoft Agent 365 तक शीघ्र पहुँच प्राप्त करने के लिए आपको Frontier पूर्वावलोकन प्रोग्राम का भाग बनने की आवश्यकता है. फ्रंटियर आपको सीधे Microsoft के नवीनतम AI नवाचारों से जोड़ता है। फ्रंटियर पूर्वावलोकन आपके ग्राहक समझौतों की मौजूदा पूर्वावलोकन शर्तों के अधीन हैं। चूंकि ये सुविधाएँ अभी भी विकास में हैं, इसलिए उनकी उपलब्धता और क्षमताएं समय के साथ बदल सकती हैं।
एजेंट 365 पारिस्थितिकी तंत्र में भाग लेने के लिए, आपको अपने एजेंट में एजेंट 365 अवलोकन क्षमताओं को जोड़ना होगा। एजेंट 365 ऑब्जर्वेबिलिटी ओपनटेलीमेट्री (ओटेल) पर आधारित है और सभी एजेंट प्लेटफार्मों पर लगातार और सुरक्षित रूप से टेलीमेट्री को कैप्चर करने के लिए एक एकीकृत ढांचा प्रदान करता है। इस आवश्यक घटक को कार्यान्वित करके, आप Microsoft व्यवस्थापन केंद्र (MAC) में अपने एजेंट की गतिविधि की निगरानी करने के लिए IT व्यवस्थापकों को सक्षम करते हैं और सुरक्षा टीमों को अनुपालन और खतरे का पता लगाने के लिए डिफेंडर और Purview का उपयोग करने की अनुमति देते हैं।
के मुख्य लाभ हैं:
-
एंड-टू-एंड दृश्यता: सत्र, टूल कॉल और अपवाद सहित प्रत्येक एजेंट आह्वान के लिए व्यापक टेलीमेट्री कैप्चर करें, जिससे आपको सभी प्लेटफार्मों पर पूर्ण पता लगाने की क्षमता मिलती है।
-
सुरक्षा और अनुपालन सक्षमता: फीड यूनिफाइड ऑडिट लॉग इन डिफेंडर और पर्व्यू, जो आपके एजेंट के लिए उन्नत सुरक्षा परिदृश्य और अनुपालन रिपोर्टिंग को सक्षम करता है।
-
क्रॉस-प्लेटफ़ॉर्म लचीलापन: OTel मानकों पर निर्माण करें और Copilot Studio, Foundry और भविष्य के एजेंट फ्रेमवर्क जैसे विविध रनटाइम और प्लेटफ़ॉर्म का समर्थन करें।
-
व्यवस्थापकों के लिए परिचालन दक्षता: MAC में केंद्रीकृत अवलोकन प्रदान करें, समस्या निवारण समय को कम करें और आपके एजेंट का प्रबंधन करने वाली IT टीमों के लिए भूमिका-आधारित पहुँच नियंत्रणों के साथ शासन में सुधार करें।
स्थापना
एजेंट 365 द्वारा समर्थित भाषाओं के लिए observability मॉड्यूल को स्थापित करने के लिए इन आदेशों का उपयोग करें।
pip install microsoft-agents-a365-observability-core
pip install microsoft-agents-a365-runtime
npm install @microsoft/agents-a365-observability
npm install @microsoft/agents-a365-runtime
dotnet add package Microsoft.Agents.A365.Observability
dotnet add package Microsoft.Agents.A365.Observability.Runtime
कॉन्फ़िगरेशन
अवलोकन के लिए आवश्यक पर्यावरण चर हैं:
| परिवेश चर |
विवरण |
ENABLE_OBSERVABILITY=true |
ट्रेसिंग को सक्षम/अक्षम करने के लिए ध्वजांकित करें। डिफ़ॉल्ट रूप से: |
ENABLE_A365_OBSERVABILITY_EXPORTER=true |
True हमारी सेवा में लॉग निर्यात करें। अन्यथा कंसोल निर्यातक के पास वापस आ जाता है |
from microsoft_agents_a365.observability.core import config
def token_resolver(agent_id: str, tenant_id: str) -> str | None:
# Implement secure token retrieval here
return "Bearer <token>"
config.configure(
service_name="my-agent-service",
service_namespace="my.namespace",
token_resolver=token_resolver,
)
कंसोल पर लॉग इन करने के लिए टोकन रिज़ॉल्वर को बाहर करें।
अवलोकन के लिए आवश्यक पर्यावरण चर हैं:
| परिवेश चर |
विवरण |
ENABLE_OBSERVABILITY=true |
ट्रेसिंग को सक्षम/अक्षम करने के लिए ध्वजांकित करें। डिफ़ॉल्ट रूप से: |
ENABLE_A365_OBSERVABILITY_EXPORTER=true |
True हमारी सेवा में लॉग निर्यात करें। अन्यथा कंसोल निर्यातक पर वापस आ जाता है |
import { ObservabilityManager } from '@microsoft/agents-a365-observability';
const tokenResolver = (agentId, tenantId) => {
// Your token resolution logic here
return "your-token";
};
// Advanced configuration with builder pattern
const builder = ObservabilityManager.configure(builder =>
builder
.withService('my-agent-service', '1.0.0')
.withTokenResolver((agentId, tenantId) => {
return tokenResolver(agentId, tenantId);
})
);
builder.start();
appsettings.json में true सेट करें
में Program.cs, सेवा संग्रह में जोड़ें Agent365ExporterOptions । यह परिवर्तन उस प्रतिनिधि को कॉन्फ़िगर करता है जिसका उपयोग ट्रेस निर्यातक टोकन को पुनर्प्राप्त करने के लिए करता है।
का उपयोग करके AddA365Tracing()अवलोकन संबंधी निर्भरताएं जोड़ें।
using Microsoft.Agents.A365.Observability.Runtime;
var builder = WebApplication.CreateBuilder(args);
builder.Services.AddSingleton(sp =>
{
return new Agent365ExporterOptions
{
ClusterCategory = "prod",
TokenResolver = async (agentId, tenantId) =>
{
// It's recommended to implement caching in your token provider for performance.
var token = await tokenProvider.GetObservabilityTokenAsync(agentId, tenantId);
return token;
}
};
});
builder.AddA365Tracing();
छवि एट्रिब्यूट
प्रासंगिक जानकारी सेट करने के लिए उपयोग करें BaggageBuilder जो एक अनुरोध में सभी स्पैन के माध्यम से प्रवाहित होती है।
SDK मौजूदा विशेषताओं को अधिलेखित किए बिना सभी गैर-खाली सामान प्रविष्टियों को नए शुरू किए गए स्पैन में कॉपी SpanProcessor करता है।
from microsoft_agents_a365.observability.core.middleware.baggage_builder import BaggageBuilder
with (
BaggageBuilder()
.tenant_id("tenant-123")
.agent_id("agent-456")
.correlation_id("corr-789")
.build()
):
# Any spans started in this context will receive these as attributes
pass
import { BaggageBuilder } from '@microsoft/agents-a365-observability';
// Create and apply baggage context
using baggageScope = new BaggageBuilder()
// Core identifiers
.tenantId('tenant-123')
.agentId('agent-456')
.correlationId('correlation-789')
.build();
// Execute operations within the baggage context
baggageScope.run(() => {
// All spans created within this context will inherit the baggage values
// Invoke another agent
using agentScope = InvokeAgentScope.start(invokeDetails, agentDetails, tenantDetails);
// ... agent logic
// Execute tools
using toolScope = ExecuteToolScope.start(toolDetails, agentDetails, tenantDetails);
// ... tool logic
});
using var baggageScope = new BaggageBuilder()
.TenantId('tenant-123')
.AgentId('agent-456')
.CorrelationId('correlation-789')
.Build();
// Any spans started in this context will receive them as attributes.
टोकन रिज़ॉल्वर
एजेंट 365 निर्यातक का उपयोग करते समय, आपको एक टोकन रिज़ॉल्वर फ़ंक्शन प्रदान करना होगा जो प्रमाणीकरण टोकन लौटाता है।
एजेंट होस्टिंग फ्रेमवर्क के साथ एजेंट 365 ऑब्जर्वेबिलिटी एसडीके का उपयोग करते समय, आप एजेंट गतिविधियों से टोकन उत्पन्न कर सकते हैं TurnContext
from microsoft_agents.activity import load_configuration_from_env
from microsoft_agents.authentication.msal import MsalConnectionManager
from microsoft_agents.hosting.aiohttp import CloudAdapter
from microsoft_agents.hosting.core import (
AgentApplication,
Authorization,
MemoryStorage,
TurnContext,
TurnState,
)
from microsoft_agents_a365.runtime.environment_utils import (
get_observability_authentication_scope,
)
agents_sdk_config = load_configuration_from_env(environ)
STORAGE = MemoryStorage()
CONNECTION_MANAGER = MsalConnectionManager(**agents_sdk_config)
ADAPTER = CloudAdapter(connection_manager=CONNECTION_MANAGER)
ADAPTER.use(TranscriptLoggerMiddleware(ConsoleTranscriptLogger()))
AUTHORIZATION = Authorization(STORAGE, CONNECTION_MANAGER, **agents_sdk_config)
AGENT_APP = AgentApplication[TurnState](
storage=STORAGE, adapter=ADAPTER, authorization=AUTHORIZATION, **agents_sdk_config
)
@AGENT_APP.activity("message", auth_handlers=["AGENTIC"])
async def on_message(context: TurnContext, _state: TurnState):
aau_auth_token = await AGENT_APP.auth.exchange_token(
context,
scopes=get_observability_authentication_scope(),
auth_handler_id="AGENTIC",
)
# cache this auth token and return via token resolver
import {
TurnState,
AgentApplication,
MemoryStorage,
TurnContext,
} from '@microsoft/agents-hosting';
import { Activity, ActivityTypes } from '@microsoft/agents-activity';
import { getObservabilityAuthenticationScope } from '@microsoft/agents-a365-runtime';
interface ConversationState {
count: number;
}
type ApplicationTurnState = TurnState<ConversationState>;
const downloader = new AttachmentDownloader();
const storage = new MemoryStorage();
export const agentApplication = new AgentApplication<ApplicationTurnState>({
authorization: {
agentic: { } // We have the type and scopes set in the .env file
},
storage,
});
agentApplication.onActivity(
ActivityTypes.Message,
async (context: TurnContext, state: ApplicationTurnState) => {
const aauAuthToken = await agentApplication.authorization.exchangeToken(context,'agentic', {
scopes: getObservabilityAuthenticationScope()
} )
// cache this auth token and return via token resolver
};
अपने सेवा संग्रह में agentic टोकन रिज़ॉल्वर जोड़ें।
using Microsoft.Agents.A365.Observability;
builder.Services.AddAgenticTracingExporter();
एजेंट एप्लिकेशन में, टोकन पंजीकृत करें।
using Microsoft.Agents.Builder;
using Microsoft.Agents.Core.Models;
using Microsoft.Extensions.Logging;
using Microsoft.Agents.A365.Observability.Caching;
using System;
using System.Threading.Tasks;
public class MyAgent : AgentApplication
{
private readonly IExporterTokenCache<AgenticTokenStruct> _agentTokenCache;
private readonly ILogger<MyAgent> _logger;
public MyAgent(AgentApplicationOptions options, IExporterTokenCache<AgenticTokenStruct> agentTokenCache, ILogger<MyAgent> logger)
: base(options)
{
_agentTokenCache = agentTokenCache ?? throw new ArgumentNullException(nameof(agentTokenCache));
_logger = logger ?? throw new ArgumentNullException(nameof(logger));
}
protected async Task MessageActivityAsync(ITurnContext turnContext, ITurnState turnState, CancellationToken cancellationToken)
{
using var baggageScope = new BaggageBuilder()
.TenantId(turnContext.Activity.Recipient.TenantId)
.AgentId(turnContext.Activity.Recipient.AgenticAppId)
.Build();
try
{
_agentTokenCache.RegisterObservability(
turnContext.Activity.Recipient.AgenticAppId,
turnContext.Activity.Recipient.TenantId,
new AgenticTokenStruct
{
UserAuthorization = UserAuthorization,
TurnContext = turnContext
},
EnvironmentUtils.GetObservabilityAuthenticationScope()
);
}
catch (Exception ex)
{
_logger.LogWarning($"Error registering for observability: {ex.Message}");
}
}
}
ऑटो-इंस्ट्रूमेंटेशन
ऑटो-इंस्ट्रूमेंटेशन स्वचालित रूप से एजेटिक फ्रेमवर्क (एसडीके) मौजूदा टेलीमेट्री संकेतों को निशान के लिए सुनता है और उन्हें एजेंट 365 अवलोकन सेवा को अग्रेषित करता है। इससे डेवलपर्स को मैन्युअल रूप से निगरानी कोड लिखने, सेटअप को सरल बनाने और लगातार प्रदर्शन ट्रैकिंग सुनिश्चित करने की आवश्यकता समाप्त हो जाती है।
ऑटो-इंस्ट्रूमेंटेशन कई SDK और प्लेटफ़ॉर्म पर समर्थित है:
नोट
ऑटो-इंस्ट्रूमेंटेशन के लिए समर्थन प्लेटफ़ॉर्म और SDK कार्यान्वयन के अनुसार भिन्न होता है।
सिमेंटिक कर्नेल
ऑटो इंस्ट्रूमेंटेशन के लिए बैगेज बिल्डर के उपयोग की आवश्यकता होती है। का उपयोग करके BaggageBuilderएजेंट आईडी और किरायेदार आईडी सेट करें।
पैकेज स्थापित करें
pip install microsoft-agents-a365-observability-extensions-semantic-kernel
अवलोकन को कॉन्फ़िगर करें
from microsoft_agents_a365.observability.core.config import configure
from microsoft_agents_a365.observability.extensions.semantic_kernel import SemanticKernelInstrumentor
# Configure observability
configure(
service_name="my-semantic-kernel-agent",
service_namespace="ai.agents"
)
# Enable auto-instrumentation
instrumentor = SemanticKernelInstrumentor()
instrumentor.instrument()
# Your Semantic Kernel code is now automatically traced
सिमेंटिक कर्नेल जावास्क्रिप्ट के साथ समर्थित नहीं है।
सेवा संग्रह में निर्भरताएँ जोड़ें.
using Microsoft.Agents.A365.Observability.Extensions.SemanticKernel;
builder.Services.AddTracing(config => config.WithSemanticKernel());
सेट करें AgentId और TenantId उपयोग कर रहे BaggageBuilderहैं। सुनिश्चित करें कि बनाने के ChatCompletionAgent दौरान उपयोग की जाने वाली आईडी उस एजेंट आईडी से मेल खाती है जिसे पास BaggageBuilderकिया गया है।
using Microsoft.Agents.A365.Observability.Extensions.SemanticKernel;
using Microsoft.Agents.A365.Observability.Runtime.Common;
public class MyAgent
{
public async Task<AgentResponse> ProcessUserRequest(string userInput)
{
using var baggageScope = new BaggageBuilder()
.AgentId(<your-agent-id>) // NOTE: This will be the agent ID with which the TokenResolver delegate is invoked.
.TenantId(<your-tenant-id>) // NOTE: This will be the tenant ID with which the TokenResolver delegate is invoked.
.Build();
var chatCompletionAgent = new ChatCompletionAgent
{
// NOTE: This will be the agent ID with which the TokenResolver delegate is invoked. Should match above.
Id = <your-agent-id>,
...
};
}
}
ओपनएआई
ऑटो इंस्ट्रूमेंटेशन के लिए बैगेज बिल्डर के उपयोग की आवश्यकता होती है। का उपयोग करके BaggageBuilderएजेंट आईडी और किरायेदार आईडी सेट करें।
पैकेज स्थापित करें।
pip install microsoft-agents-a365-observability-extensions-openai
अवलोकन को कॉन्फ़िगर करें।
from microsoft_agents_a365.observability.core.config import configure
from microsoft_agents_a365.observability.extensions.openai_agents import OpenAIAgentsTraceInstrumentor
# Configure observability
configure(
service_name="my-openai-agent",
service_namespace="ai.agents"
)
# Enable auto-instrumentation
instrumentor = OpenAIAgentsTraceInstrumentor()
instrumentor.instrument()
# Your OpenAI Agents code is now automatically traced
पैकेज स्थापित करें
npm install @microsoft/agents-a365-observability-extensions-openai
अवलोकन को कॉन्फ़िगर करें
import { ObservabilityManager } from '@microsoft/agents-a365-observability';
import { OpenAIAgentsTraceInstrumentor } from '@microsoft/agents-a365-observability-extensions-openai';
// Configure observability first
const sdk = ObservabilityManager.configure((builder) =>
builder
.withService('My Agent Service', '1.0.0')
.withConsoleExporter(true)
);
// Create and enable the instrumentor
const instrumentor = new OpenAIAgentsTraceInstrumentor({
enabled: true,
tracerName: 'openai-agents-tracer',
tracerVersion: '1.0.0'
});
sdk.start();
instrumentor.enable();
सेवा संग्रह में निर्भरताएँ जोड़ें.
using Microsoft.Agents.A365.Observability.Extensions.OpenAI;
builder.Services.AddTracing(config => config.WithOpenAI());
सेट करें AgentId और TenantId उपयोग कर रहे BaggageBuilderहैं। टूल कॉल के लिए, किसी इंस्टेंस ChatToolCall का उपयोग करके Trace() ट्रेस प्रारंभ करें.
using Microsoft.Agents.A365.Observability.Extensions.OpenAI;
using Microsoft.Agents.A365.Observability.Runtime.Common;
public class MyAgent
{
public async Task<AgentResponse> ProcessUserRequest(string userInput)
{
using var baggageScope = new BaggageBuilder()
.AgentId(<your-agent-id>) // NOTE: This will be the agent ID with which the TokenResolver delegate is invoked.
.TenantId(<your-tenant-id>) // NOTE: This will be the tenant ID with which the TokenResolver delegate is invoked.
.Build();
// NOTE: This will be the agent and tenant ID with which the TokenResolver delegate will be invoked.
using var scope = chatToolCall.Trace(agentId: <your-agent-id>, <your-tenant-id>);
}
}
एजेंट फ्रेमवर्क
ऑटो इंस्ट्रूमेंटेशन के लिए बैगेज बिल्डर के उपयोग की आवश्यकता होती है। BaggageBuilder का उपयोग करके एजेंट आईडी और टेनेंट आईडी सेट करें।
पैकेज स्थापित करें
pip install microsoft-agents-a365-observability-extensions-agent-framework
अवलोकन को कॉन्फ़िगर करें
from microsoft_agents_a365.observability.core.config import configure
from microsoft_agents_a365.observability.extensions.agentframework.trace_instrumentor import (
AgentFrameworkInstrumentor,
)
# Configure observability
configure(
service_name="AgentFrameworkTracingWithAzureOpenAI",
service_namespace="AgentFrameworkTesting",
)
# Enable auto-instrumentation
AgentFrameworkInstrumentor().instrument()
एजेंट फ़्रेमवर्क जावास्क्रिप्ट के साथ समर्थित नहीं है।
सेवा संग्रह में निर्भरताएँ जोड़ें.
using Microsoft.Agents.A365.Observability.Extensions.AgentFramework;
builder.Services.AddTracing(config => config.WithAgentFramework());
सेट करें AgentId और TenantId उपयोग कर रहे BaggageBuilderहैं।
using Microsoft.Agents.A365.Observability.Runtime.Common;
public class MyAgent : AgentApplication
{
protected async Task MessageActivityAsync(ITurnContext turnContext, ITurnState turnState, CancellationToken cancellationToken)
{
using var baggageScope = new BaggageBuilder()
.AgentId(<your-agent-id>) // NOTE: This will be the agent ID with which the TokenResolver delegate is invoked.
.TenantId(<your-tenant-id>) // NOTE: This will be the tenant ID with which the TokenResolver delegate is invoked.
.Build();
}
}
लैंगचेन फ्रेमवर्क
ऑटो-इंस्ट्रूमेंटेशन के लिए बैगेज बिल्डर के उपयोग की आवश्यकता होती है। का उपयोग करके BaggageBuilderएजेंट आईडी और किरायेदार आईडी सेट करें।
पैकेज स्थापित करें।
pip install microsoft-agents-a365-observability-extensions-langchain
अवलोकन को कॉन्फ़िगर करें
from microsoft_agents_a365.observability.core.config import configure
from microsoft_agents_a365.observability.extensions.langchain import CustomLangChainInstrumentor
# Configure observability
configure(
service_name="my-langchain-agent",
service_namespace="ai.agents"
)
# Enable auto-instrumentation
CustomLangChainInstrumentor()
# Your LangChain code is now automatically traced
मैनुअल इंस्ट्रूमेंटेशन
एजेंट 365 अवलोकन एसडीके का उपयोग एजेंट के आंतरिक कामकाज को समझने के लिए किया जा सकता है।
एसडीके तीन स्कोप प्रदान करता है जिन्हें शुरू किया जा सकता है: InvokeAgentScope, , ExecuteToolScopeऔर InferenceScope.
एजेंट आह्वान
इस दायरे का उपयोग आपकी एजेंट प्रक्रिया की शुरुआत में किया जाना चाहिए। इनवोक एजेंट स्कोप के साथ, आप वर्तमान एजेंट को लागू किए जा रहे गुणों, एजेंट उपयोगकर्ता डेटा आदि को कैप्चर करते हैं।
from microsoft_agents_a365.observability.core.invoke_agent_scope import InvokeAgentScope
from microsoft_agents_a365.observability.core.invoke_agent_details import InvokeAgentDetails
from microsoft_agents_a365.observability.core.tenant_details import TenantDetails
from microsoft_agents_a365.observability.core.request import Request
invoke_details = InvokeAgentDetails(
details=agent_details, # AgentDetails instance
endpoint=my_endpoint, # Optional endpoint (with hostname/port)
session_id="session-42"
)
tenant_details = TenantDetails(tenant_id="tenant-123")
req = Request(content="User asks a question")
with InvokeAgentScope.start(invoke_details, tenant_details, req):
# Perform agent invocation logic
response = call_agent(...)
import {
InvokeAgentScope,
ExecutionType,
CallerDetails,
EnhancedAgentDetails
} from '@microsoft/agents-a365-observability';
// Basic agent invocation details
const invokeDetails = {
agentId: 'email-agent-123',
agentName: 'Email Assistant',
...
}
};
const tenantDetails = {
tenantId: 'tenant-789'
};
// Optional: Caller details (human user)
const callerDetails: CallerDetails = {};
// Optional: Caller agent details (for agent-to-agent calls)
const callerAgentDetails: EnhancedAgentDetails = {};
// Enhanced invocation with caller context
using scope = InvokeAgentScope.start(
invokeDetails,
tenantDetails,
callerAgentDetails,
callerDetails
);
try {
// Record input messages
scope.recordInputMessages(['Please help me organize my emails', 'Focus on urgent items']);
// Your agent invocation logic here
const response = await invokeAgent(invokeDetails.request.content);
// Record output messages
scope.recordOutputMessages(['I found 15 urgent emails', 'Here is your organized inbox']);
} catch (error) {
scope.recordError(error as Error);
throw error;
}
// Scope automatically disposed at end of using block
using System;
using System.Threading.Tasks;
using Microsoft.Agents.A365.Observability.Runtime.Tracing.Contracts;
using Microsoft.Agents.A365.Observability.Runtime.Tracing.Scopes;
public class MyAgent
{
public async Task<AgentResponse> ProcessUserRequest(string userInput)
{
var agentDetails = new AgentDetails(
agentId: Guid.NewGuid().ToString(),
agentName: "MyAgent",
agentDescription: "Handles user requests.",
tenantId: "tenant-789"
);
var tenantDetails = new TenantDetails(Guid.Parse("11111111-2222-3333-4444-555555555555"));
var request = new Request(
content: userInput,
executionType: ExecutionType.HumanToAgent,
sessionId: "session-abc",
channelMetadata: new ChannelMetadata("webchat", "https://webchat.contoso.com")
);
var callerDetails = new CallerDetails(
callerId: "user-123",
callerName: "Jane Doe",
callerUpn: "jane.doe@contoso.com",
callerUserId: "user-uuid-456",
tenantId: "tenant-789"
);
var endpoint = new Uri("https://myagent.contoso.com");
var invokeAgentDetails = new InvokeAgentDetails(endpoint, agentDetails, sessionId: "session-abc");
var conversationId = "conv-xyz";
// Start the scope
using var scope = InvokeAgentScope.Start(
invokeAgentDetails: invokeAgentDetails,
tenantDetails: tenantDetails,
request: request,
callerAgentDetails: null,
callerDetails: callerDetails,
conversationId: conversationId
);
// Record input messages
scope.RecordInputMessages(new[] { userInput });
// ... your agent logic here ...
// Simulate agent processing and output
var output = $"Processed: {userInput}";
scope.RecordOutputMessages(new[] { output });
// Optionally record a single response
scope.RecordResponse(output);
return new AgentResponse { Content = output };
}
}
public class AgentResponse
{
public string Content { get; set; }
}
निम्नलिखित उदाहरण प्रदर्शित करते हैं कि निगरानी और ऑडिटिंग उद्देश्यों के लिए टेलीमेट्री को कैप्चर करने के लिए अवलोकन ट्रैकिंग के साथ अपने एजेंट के टूल निष्पादन को कैसे इंस्ट्रूमेंट किया जाए।
from microsoft_agents_a365.observability.core.execute_tool_scope import ExecuteToolScope
from microsoft_agents_a365.observability.core.tool_call_details import ToolCallDetails
tool_details = ToolCallDetails(
tool_name="summarize",
tool_type="function",
tool_call_id="tc-001",
arguments="{'text': '...'}",
description="Summarize provided text",
endpoint=None # or endpoint object with hostname/port
)
with ExecuteToolScope.start(tool_details, agent_details, tenant_details):
result = run_tool(tool_details)
import { ExecuteToolScope } from '@microsoft/agents-a365-observability';
const toolDetails = {
toolName: 'email-search',
arguments: JSON.stringify({ query: 'from:boss@company.com', limit: 10 }),
toolCallId: 'tool-call-456',
description: 'Search emails by criteria',
toolType: 'function',
endpoint: {
host: 'tools.contoso.com',
port: 8080, // Will be recorded since not 443
protocol: 'https'
}
};
using scope = ExecuteToolScope.start(toolDetails, agentDetails, tenantDetails);
try {
// Execute the tool
const result = await searchEmails(toolDetails.arguments);
// Record the tool execution result
scope.recordResponse(JSON.stringify(result));
return result;
} catch (error) {
scope.recordError(error as Error);
throw error;
}
using System;
using System.Threading.Tasks;
using Microsoft.Agents.A365.Observability.Runtime.Tracing.Contracts;
using Microsoft.Agents.A365.Observability.Runtime.Tracing.Scopes;
public class MyToolAgent
{
public async Task<ToolResult> ExecuteTool(string toolName, object parameters)
{
var agentDetails = new AgentDetails(
agentId: Guid.NewGuid().ToString(),
agentName: "ToolAgent",
agentDescription: "Executes tools for users.",
agentAUID: "tool-auid-123",
agentUPN: "toolagent@contoso.com",
agentBlueprintId: "tool-blueprint-456",
agentType: AgentType.EntraEmbodied,
tenantId: "tenant-789"
);
var tenantDetails = new TenantDetails(Guid.Parse("11111111-2222-3333-4444-555555555555"));
var endpoint = new Uri("https://toolagent.contoso.com:8443");
var toolCallDetails = new ToolCallDetails(
toolName: toolName,
arguments: System.Text.Json.JsonSerializer.Serialize(parameters),
toolCallId: Guid.NewGuid().ToString(),
description: "Runs a tool operation.",
toolType: "custom-type",
endpoint: endpoint
);
// Start the scope
using var scope = ExecuteToolScope.Start(
toolCallDetails: toolCallDetails,
agentDetails: agentDetails,
tenantDetails: tenantDetails
);
// ... your tool logic here ...
// Record response
var toolOutput = $"Tool '{toolName}' processed with parameters: {System.Text.Json.JsonSerializer.Serialize(parameters)}";
scope.RecordResponse(toolOutput);
return new ToolResult { Output = toolOutput };
}
}
public class ToolResult
{
public string Output { get; set; }
}
अनुमान
निम्नलिखित उदाहरण दिखाते हैं कि टोकन उपयोग, मॉडल विवरण और प्रतिक्रिया मेटाडेटा को कैप्चर करने के लिए अवलोकन ट्रैकिंग के साथ एआई मॉडल अनुमान कॉल को कैसे इंस्ट्रूमेंट किया जाए।
from microsoft_agents_a365.observability.core.inference_scope import InferenceScope
from microsoft_agents_a365.observability.core.inference_call_details import InferenceCallDetails
from microsoft_agents_a365.observability.core.request import Request
inference_details = InferenceCallDetails(
operationName=SomeEnumOrValue("chat"),
model="gpt-4o-mini",
providerName="azure-openai",
inputTokens=123,
outputTokens=456,
finishReasons=["stop"],
responseId="resp-987"
)
req = Request(content="Explain quantum computing simply.")
with InferenceScope.start(inference_details, agent_details, tenant_details, req):
completion = call_llm(...)
import { InferenceScope, InferenceOperationType } from '@microsoft/agents-a365-observability';
const inferenceDetails = {
operationName: InferenceOperationType.CHAT,
model: 'gpt-4',
providerName: 'openai',
inputTokens: 150,
outputTokens: 75,
finishReasons: ['stop'],
responseId: 'resp-123456'
};
using scope = InferenceScope.start(inferenceDetails, agentDetails, tenantDetails);
try {
// Record input messages
scope.recordInputMessages(['Summarize the following emails for me...']);
// Call the LLM
const response = await callLLM();
// Record detailed telemetry with granular methods
scope.recordOutputMessages(['Here is your email summary...']);
scope.recordInputTokens(145); // Update if different from constructor
scope.recordOutputTokens(82); // Update if different from constructor
scope.recordResponseId('resp-789123');
scope.recordFinishReasons(['stop', 'max_tokens']);
return response.text;
} catch (error) {
scope.recordError(error as Error);
throw error;
}
using System;
using System.Threading.Tasks;
using Microsoft.Agents.A365.Observability.Runtime.Tracing.Contracts;
using Microsoft.Agents.A365.Observability.Runtime.Tracing.Scopes;
public class MyInferenceAgent
{
public async Task<InferenceResult> RunInference(string input)
{
var agentDetails = new AgentDetails(
agentId: Guid.NewGuid().ToString(),
agentName: "InferenceAgent",
agentDescription: "Performs generative AI inference.",
agentAUID: "inference-auid-123",
agentUPN: "inferenceagent@contoso.com",
agentBlueprintId: "inference-blueprint-456",
agentType: AgentType.EntraEmbodied,
tenantId: "tenant-789"
);
var tenantDetails = new TenantDetails(Guid.Parse("11111111-2222-3333-4444-555555555555"));
var inferenceDetails = new InferenceCallDetails(
operationName: InferenceOperationType.Chat,
model: "gpt-4",
providerName: "OpenAI",
inputTokens: 42,
outputTokens: 84,
finishReasons: new[] { "stop", "length" },
responseId: "response-xyz"
);
// Start the scope
using var scope = InferenceScope.Start(
details: inferenceDetails,
agentDetails: agentDetails,
tenantDetails: tenantDetails
);
// ... your inference logic here ...
// Record input/output messages and other telemetry
scope.RecordInputMessages(new[] { input, "additional context" });
scope.RecordOutputMessages(new[] { "AI response message" });
scope.RecordInputTokens(42);
scope.RecordOutputTokens(84);
scope.RecordResponseId("response-xyz");
scope.RecordFinishReasons(new[] { "stop", "length" });
scope.RecordThoughtProcess("Reasoning step 1; step 2");
return new InferenceResult { Output = "AI response message" };
}
}
public class InferenceResult
{
public string Output { get; set; }
}
स्थानीय स्तर पर मान्य करें
परिवेश चर सहेजें. यह कंसोल करने के लिए फैलाता है (निशान)।
परिवेश चर सहेजें. यह कंसोल करने के लिए फैलाता है (निशान)।
appsettings.json में false सेट करें यह कंसोल करने के लिए फैलाता है (निशान)।
अवलोकन के साथ अपने एजेंट का परीक्षण करें
अपने एजेंट में अवलोकन को लागू करने के बाद, यह सुनिश्चित करने के लिए परीक्षण करें कि टेलीमेट्री सही ढंग से कैप्चर की जा रही है। अपने परिवेश को सेट करने के लिए परीक्षण मार्गदर्शिका का पालन करें, फिर मुख्य रूप से अवलोकन योग्यता लॉग देखें अनुभाग पर ध्यान केंद्रित करें ताकि यह सत्यापित किया जा सके कि आपका अवलोकन कार्यान्वयन अपेक्षित रूप से काम कर रहा है।