ExecuteToolScope class

Paket:
@microsoft/agents-a365-observability

Yapay zeka aracı yürütme işlemleri için OpenTelemetry izleme kapsamı sağlar.

Extends
OpenTelemetryScope

Yöntemler

recordResponse(string | Record<string, unknown>)

Telemetri izleme için yanıt bilgilerini kaydeder.
start(Request, ToolCallDetails, AgentDetails, UserDetails, SpanDetails)

Araç yürütme 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ı

recordResponse(string | Record<string, unknown>)

Telemetri izleme için yanıt bilgilerini kaydeder.

function recordResponse(response: string | Record<string, unknown>)

Parametreler

response

string | Record<string, unknown>

Araç yürütme yanıtı. Nesneler otomatik olarak JSON olarak serileştirilir.

start(Request, ToolCallDetails, AgentDetails, UserDetails, SpanDetails)

Araç yürütme izlemesi için yeni bir kapsam oluşturur ve başlatır.

static function start(request: Request, details: ToolCallDetails, agentDetails: AgentDetails, userDetails?: UserDetails, spanDetails?: SpanDetails): ExecuteToolScope

Parametreler

request
Request

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

details
ToolCallDetails

Araç çağrısı ayrıntıları (ad, tür, args, çağrı kimliği vb.).

agentDetails
AgentDetails

Aracı aracıyı yürütür. Kiracı Kimliği' nden agentDetails.tenantIdtüretilir.

userDetails
UserDetails

İsteğe bağlı insan arayan kimliği.

spanDetails
SpanDetails

İsteğe bağlı span yapılandırması (parentContext, startTime, endTime, spanLinks, spanKind). Varsayılan olarak SpanKind.INTERNAL'yi kullanır.

Döndürülenler

ExecuteToolScope

Yeni bir ExecuteToolScope ö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ı