Skip to main content

DebugEvent Interface

Core Debug event type for the ai-collab

This API is provided as an alpha preview and may change without notice.

To use, import via @fluidframework/ai-collab/alpha.

For more information about our API support guarantees, see here.

Signature

export interface DebugEvent

Properties

Property Alerts Type Description
eventName Alpha string The name of the debug event.
id Alpha string The unique id of the debug event.
timestamp Alpha string The date and time at which the debug event was created.
traceId Alpha string An id that will be shared across all debug events that originate from the same single execution of ai-collab.

Property Details

eventName

The name of the debug event.

This API is provided as an alpha preview and may change without notice.

For more information about our API support guarantees, see here.

Signature

eventName: string;

Type: string

id

The unique id of the debug event.

This API is provided as an alpha preview and may change without notice.

For more information about our API support guarantees, see here.

Signature

id: string;

Type: string

timestamp

The date and time at which the debug event was created.

This API is provided as an alpha preview and may change without notice.

For more information about our API support guarantees, see here.

Signature

timestamp: string;

Type: string

traceId

An id that will be shared across all debug events that originate from the same single execution of ai-collab.

This API is provided as an alpha preview and may change without notice.

For more information about our API support guarantees, see here.

Signature

traceId: string;

Type: string

Remarks

This is intended to be used to correlate all debug events that originate from the same execution