InferenceScope class

Paket:

@microsoft/agents-a365-observability

Oluşturma yapay zeka çıkarım işlemleri için OpenTelemetry izleme kapsamı sağlar.

Extends

OpenTelemetryScope

Yöntemler

recordFinishReasons(string[])	Telemetri izlemenin bitiş nedenlerini kaydeder.
recordInputMessages(InputMessagesParam)	Telemetri izleme için giriş iletilerini kaydeder. Düz dizeleri (rolüyle userOTEL ChatMessage olarak otomatik sarmalanmış) veya bir sürüme sahip InputMessages sarmalayıcısını kabul eder.
recordInputTokens(number)	Telemetri izleme için giriş belirteçlerinin sayısını kaydeder.
recordOutputMessages(OutputMessagesParam)	Telemetri izleme için çıkış iletilerini kaydeder. Düz dizeleri (rolüyle assistantOTEL OutputMessage olarak otomatik sarmalanmış) veya sürümlenmiş OutputMessages sarmalayıcısını kabul eder.
recordOutputTokens(number)	Telemetri izleme için çıkış belirteçlerinin sayısını kaydeder.
start(Request, InferenceDetails, AgentDetails, UserDetails, SpanDetails)	Çıkarım izleme 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ı

recordFinishReasons(string[])

Telemetri izlemenin bitiş nedenlerini kaydeder.

function recordFinishReasons(finishReasons: string[])

Parametreler

finishReasons

string[]

Bitiş nedenleri dizisi

recordInputMessages(InputMessagesParam)

Telemetri izleme için giriş iletilerini kaydeder. Düz dizeleri (rolüyle userOTEL ChatMessage olarak otomatik sarmalanmış) veya bir sürüme sahip InputMessages sarmalayıcısını kabul eder.

function recordInputMessages(messages: InputMessagesParam)

Parametreler

messages

InputMessagesParam

Giriş iletisi dizeleri dizisi veya InputMessages sarmalayıcı

recordInputTokens(number)

Telemetri izleme için giriş belirteçlerinin sayısını kaydeder.

function recordInputTokens(inputTokens: number)

Parametreler

inputTokens

number

Giriş belirteci sayısı

recordOutputMessages(OutputMessagesParam)

Telemetri izleme için çıkış iletilerini kaydeder. Düz dizeleri (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

Çıkış iletisi dizeleri dizisi veya OutputMessages sarmalayıcı

recordOutputTokens(number)

Telemetri izleme için çıkış belirteçlerinin sayısını kaydeder.

function recordOutputTokens(outputTokens: number)

Parametreler

outputTokens

number

Çıkış belirteci sayısı

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

Çıkarım izleme için yeni bir kapsam oluşturur ve başlatır.

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

Parametreler

request

Request

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

details

InferenceDetails

Çıkarım çağrısı ayrıntıları (model, sağlayıcı, belirteçler vb.).

agentDetails

AgentDetails

Çıkarım yapan aracı. 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). Not: spanKind yoksayılır; InferenceScope her zaman kullanır SpanKind.CLIENT.

Döndürülenler

InferenceScope

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