InvokeAgentScope class

Paket:

@microsoft/agents-a365-observability

Yapay zeka aracısı çağırma işlemleri için OpenTelemetry izleme kapsamı sağlar.

Extends

OpenTelemetryScope

Yöntemler

recordInputMessages(InputMessagesParam)	Telemetri izleme için giriş iletilerini kaydeder. Tek bir dizeyi, bir dizi dizeyi (rolüyle userOTEL ChatMessage olarak otomatik sarmalanmış) veya sürümlenmiş bir InputMessages sarmalayıcısını kabul eder.
recordOutputMessages(OutputMessagesParam)	Telemetri izleme için çıkış iletilerini kaydeder. Tek bir dizeyi, bir dize dizisini (rolüyle assistantOTEL OutputMessage olarak otomatik sarmalanmış) veya sürümlenmiş outputmessages sarmalayıcısını kabul eder.
recordResponse(string)	Telemetri izleme için yanıt bilgilerini kaydeder.
start(Request, InvokeAgentScopeDetails, AgentDetails, CallerDetails, SpanDetails)	Aracı çağırma izlemesi için yeni bir kapsam oluşturur ve başlatır.

Devralınan Yöntemler

dispose()	Uyumluluk için eski dispose yöntemi
getSpanContext()	Bu kapsam için span bağlamını alır. Bu, zaman uyumsuz sınırlar arasında açık üst-alt bağlantı için bir ParentSpanRef oluşturmak için kullanılabilir.
recordAttributes(undefined | null | Iterable<[string, AttributeValue]> | Record<string, AttributeValue>)	Telemetri izleme için birden çok öznitelik anahtarı/değer çifti kaydeder.
recordCancellation(string)	Yayılma alanındaki bir iptal olayını kaydeder. İptal nedeni ile span durumunu ERROR olarak ayarlar ve hata türünü 'TaskCanceledException' olarak işaretler.
recordError(Error)	İşlem sırasında oluşan bir hatayı kaydeder
setEndTime(TimeInput)	Kapsam için özel bir bitiş zamanı ayarlar. Ayarlandığında, dispose geçerli duvar saati saatini kullanmak yerine bu değeri 'a span.end() geçirir. Bu, kapsam atılmadan önce işlemin gerçek bitiş zamanı bilindiğinde yararlıdır.
withActiveSpanAsync<T>(() => Promise<T>)	Zaman uyumsuz geri çağırma yürütme süresi boyunca bu yayılma alanını etkin hale getirir

Yöntem Ayrıntıları

recordInputMessages(InputMessagesParam)

Telemetri izleme için giriş iletilerini kaydeder. Tek bir dizeyi, bir dizi dizeyi (rolüyle userOTEL ChatMessage olarak otomatik sarmalanmış) veya sürümlenmiş bir InputMessages sarmalayıcısını kabul eder.

function recordInputMessages(messages: InputMessagesParam)

Parametreler

messages

InputMessagesParam

Dize, dize dizisi veya InputMessages sarmalayıcı

recordOutputMessages(OutputMessagesParam)

Telemetri izleme için çıkış iletilerini kaydeder. Tek bir dizeyi, bir dize dizisini (rolüyle assistantOTEL OutputMessage olarak otomatik sarmalanmış) veya sürümlenmiş outputmessages sarmalayıcısını kabul eder.

function recordOutputMessages(messages: OutputMessagesParam)

Parametreler

messages

OutputMessagesParam

Dize, dize dizisi veya OutputMessages sarmalayıcı

recordResponse(string)

Telemetri izleme için yanıt bilgilerini kaydeder.

function recordResponse(response: string)

Parametreler

response

string

Çağırma yanıtı

start(Request, InvokeAgentScopeDetails, AgentDetails, CallerDetails, SpanDetails)

Aracı çağırma izlemesi için yeni bir kapsam oluşturur ve başlatır.

static function start(request: Request, invokeScopeDetails: InvokeAgentScopeDetails, agentDetails: AgentDetails, callerDetails?: CallerDetails, spanDetails?: SpanDetails): InvokeAgentScope

Parametreler

request

Request

İstek yükü (channel, conversationId, content, sessionId).

invokeScopeDetails

InvokeAgentScopeDetails

Kapsam düzeyi ayrıntıları

agentDetails

AgentDetails

Aracı kimliği. Kiracı kimliği (gerekli) dosyasından agentDetails.tenantId türetilir.

callerDetails

CallerDetails

İsteğe bağlı arayan bilgileri. Üç senaryo destekler:

• Yalnızca insan arayan: { userDetails: { userId, userName, ... } }
• Yalnızca aracı çağıran: { callerAgentDetails: { agentId, agentName, ... } }
• Her ikisi de (zincirde insan olan A2A): { userDetails: { ... }, callerAgentDetails: { ... } }

spanDetails

SpanDetails

İsteğe bağlı span yapılandırması (parentContext, startTime, endTime, spanKind, spanLinks).

Döndürülenler

InvokeAgentScope

Yeni bir InvokeAgentScope örneği.

Devralınan Yöntemin Ayrıntıları

dispose()

Uyumluluk için eski dispose yöntemi

function dispose()

OpenTelemetryScope.dispose'tanDevralındı

getSpanContext()

Bu kapsam için span bağlamını alır. Bu, zaman uyumsuz sınırlar arasında açık üst-alt bağlantı için bir ParentSpanRef oluşturmak için kullanılabilir.

function getSpanContext(): SpanContext

Döndürülenler

SpanContext

traceId ve spanId içeren SpanContext

OpenTelemetryScope.getSpanContext'tenDevralındı

recordAttributes(undefined | null | Iterable<[string, AttributeValue]> | Record<string, AttributeValue>)

Telemetri izleme için birden çok öznitelik anahtarı/değer çifti kaydeder.

function recordAttributes(attributes: undefined | null | Iterable<[string, AttributeValue]> | Record<string, AttributeValue>)

Parametreler

attributes

undefined | null | Iterable<[string, AttributeValue]> | Record<string, AttributeValue>

Öznitelik anahtarı/değer çiftleri koleksiyonu ([anahtar, değer] veya nesne eşlemesinin dizisi veya yinelenebilir olması).

OpenTelemetryScope.recordAttributes'tenDevralındı

recordCancellation(string)

Yayılma alanındaki bir iptal olayını kaydeder. İptal nedeni ile span durumunu ERROR olarak ayarlar ve hata türünü 'TaskCanceledException' olarak işaretler.

function recordCancellation(reason?: string)

Parametreler

reason

string

İsteğe bağlı iptal nedeni. Varsayılan olarak 'Görev iptal edildi'.

OpenTelemetryScope.recordCancellation'danDevralındı

recordError(Error)

İşlem sırasında oluşan bir hatayı kaydeder

function recordError(error: Error)

Parametreler

error

Error

Meydana gelen hata

OpenTelemetryScope.recordError'danDevralındı

setEndTime(TimeInput)

Kapsam için özel bir bitiş zamanı ayarlar. Ayarlandığında, dispose geçerli duvar saati saatini kullanmak yerine bu değeri 'a span.end() geçirir. Bu, kapsam atılmadan önce işlemin gerçek bitiş zamanı bilindiğinde yararlıdır.

function setEndTime(endTime: TimeInput)

Parametreler

endTime

TimeInput

Dönem, Tarih veya HrTime demetlerinden bu yana geçen bitiş süresi milisaniyedir.

OpenTelemetryScope.setEndTime'danDevralındı

withActiveSpanAsync<T>(() => Promise<T>)

Zaman uyumsuz geri çağırma yürütme süresi boyunca bu yayılma alanını etkin hale getirir

function withActiveSpanAsync<T>(callback: () => Promise<T>): Promise<T>

Parametreler

callback

() => Promise<T>

Döndürülenler

Promise<T>

OpenTelemetryScope.withActiveSpanAsync'tenDevralındı