Class InferenceScope

Provides OpenTelemetry tracing scope for generative AI inference operations.

Hierarchy (View Summary)

OpenTelemetryScope
- InferenceScope

Index

Properties

Methods

[dispose] dispose getSpanContext recordAttributes recordCancellation recordError recordFinishReasons recordInputMessages recordInputTokens recordOutputMessages recordOutputTokens setEndTime setTagMaybe withActiveSpanAsync start

Properties

`Protected` `Readonly`span

span: Span

Methods

[dispose]

"[dispose]"(): void
Disposes the scope and finalizes telemetry data collection.

Returns void
Inherited from OpenTelemetryScope.[dispose]
- Defined in a365/scopes/OpenTelemetryScope.ts:263

dispose

dispose(): void
Legacy dispose method for compatibility.

Returns void
Inherited from OpenTelemetryScope.dispose
- Defined in a365/scopes/OpenTelemetryScope.ts:275

getSpanContext

getSpanContext(): SpanContext
Gets the span context for this scope.

Returns SpanContext
Inherited from OpenTelemetryScope.getSpanContext
- Defined in a365/scopes/OpenTelemetryScope.ts:148

recordAttributes

recordAttributes(
    attributes:
        | Iterable<[string, AttributeValue], any, any>
        | Record<string, AttributeValue>
        | null
        | undefined,
): void
Records multiple attribute key/value pairs.
Parameters
- attributes:
      | Iterable<[string, AttributeValue], any, any>
      | Record<string, AttributeValue>
      | null
      | undefined
Returns void
Inherited from OpenTelemetryScope.recordAttributes
- Defined in a365/scopes/OpenTelemetryScope.ts:168

recordCancellation

recordCancellation(reason?: string): void
Records a cancellation event on the span.
Parameters
- Optionalreason: string
Returns void
Inherited from OpenTelemetryScope.recordCancellation
- Defined in a365/scopes/OpenTelemetryScope.ts:225

recordError

recordError(error: Error): void
Records an error that occurred during the operation.
Parameters
- error: Error
Returns void
Inherited from OpenTelemetryScope.recordError
- Defined in a365/scopes/OpenTelemetryScope.ts:153

recordFinishReasons

recordFinishReasons(finishReasons: string[]): void
Records the finish reasons.
Parameters
- finishReasons: string[]
Returns void
- Defined in a365/scopes/InferenceScope.ts:101

recordInputMessages

recordInputMessages(messages: InputMessagesParam): void
Records the input messages for telemetry tracking.
Parameters
- messages: InputMessagesParam
Returns void
Overrides OpenTelemetryScope.recordInputMessages
- Defined in a365/scopes/InferenceScope.ts:108

recordInputTokens

recordInputTokens(inputTokens: number): void
Records the number of input tokens.
Parameters
- inputTokens: number
Returns void
- Defined in a365/scopes/InferenceScope.ts:91

recordOutputMessages

recordOutputMessages(messages: OutputMessagesParam): void
Records the output messages for telemetry tracking.
Parameters
- messages: OutputMessagesParam
Returns void
Overrides OpenTelemetryScope.recordOutputMessages
- Defined in a365/scopes/InferenceScope.ts:113

recordOutputTokens

recordOutputTokens(outputTokens: number): void
Records the number of output tokens.
Parameters
- outputTokens: number
Returns void
- Defined in a365/scopes/InferenceScope.ts:96

setEndTime

setEndTime(endTime: TimeInput): void
Sets a custom end time for the scope. When set, dispose() will pass this value to span.end() instead of using wall-clock time.
Parameters
- endTime: TimeInput
Returns void
Inherited from OpenTelemetryScope.setEndTime
- Defined in a365/scopes/OpenTelemetryScope.ts:220

`Protected`setTagMaybe

setTagMaybe<T extends string | number | boolean | string[] | number[]>(
name: string,
value: T | null | undefined,
): void
Sets a tag on the span if the value is not null or undefined.
Type Parameters
- T extends string | number | boolean | string[] | number[]
Parameters
- name: string
- value: T | null | undefined
Returns void
Inherited from OpenTelemetryScope.setTagMaybe
- Defined in a365/scopes/OpenTelemetryScope.ts:205

withActiveSpanAsync

withActiveSpanAsync<T>(callback: () => Promise<T>): Promise<T>
Makes this span active for the duration of the async callback execution.
Type Parameters
- T
Parameters
- callback: () => Promise<T>
Returns Promise<T>
Inherited from OpenTelemetryScope.withActiveSpanAsync
- Defined in a365/scopes/OpenTelemetryScope.ts:142

`Static`start

start(
    request: A365Request,
    details: InferenceDetails,
    agentDetails: AgentDetails,
    userDetails?: UserDetails,
    spanDetails?: A365SpanDetails,
): InferenceScope
Creates and starts a new scope for inference tracing.
Parameters
- request: A365Request
  Request payload (channel, conversationId, content, sessionId).
- details: InferenceDetails
  The inference call details (model, provider, tokens, etc.).
- agentDetails: AgentDetails
  The agent performing the inference. tenantId is required.
- OptionaluserDetails: UserDetails
  Optional human caller identity.
- OptionalspanDetails: A365SpanDetails
  Optional span configuration. spanKind is always CLIENT.
Returns InferenceScope
- Defined in a365/scopes/InferenceScope.ts:30

Class InferenceScope

Hierarchy (View Summary)

Index

Properties

Methods

Properties

Protected Readonlyspan

Methods

[dispose]

Returns void

dispose

Returns void

getSpanContext

Returns SpanContext

recordAttributes

Parameters

Returns void

recordCancellation

Parameters

Returns void

recordError

Parameters

Returns void

recordFinishReasons

Parameters

Returns void

recordInputMessages

Parameters

Returns void

recordInputTokens

Parameters

Returns void

recordOutputMessages

Parameters

Returns void

recordOutputTokens

Parameters

Returns void

setEndTime

Parameters

Returns void

ProtectedsetTagMaybe

Type Parameters

Parameters

Returns void

withActiveSpanAsync

Type Parameters

Parameters

Returns Promise<T>

Staticstart

Parameters

Returns InferenceScope

Settings

On This Page

`Protected` `Readonly`span

`Protected`setTagMaybe

`Static`start