dd-trace
    Preparing search index...

    Interface LLMObsSpanOptions

    interface LLMObsSpanOptions {
        childOf?: SpanContext | Span;
        kind: spanKind;
        mlApp?: string;
        modelName?: string;
        modelProvider?: string;
        references?: Reference[];
        sessionId?: string;
        startTime?: number;
        tags?: { [key: string]: any };
    }

    Hierarchy (View Summary)

    Index

    Properties

    childOf? kind mlApp? modelName? modelProvider? references? sessionId? startTime? tags?

    Properties

    childOf?: SpanContext | Span

    a parent SpanContext (or Span, for convenience) that the newly-started span will be the child of (per REFERENCE_CHILD_OF). If specified, references must be unspecified.

    kind: spanKind

    LLM Observability span kind. One of agent, workflow, task, tool, retrieval, embedding, or llm.

    mlApp?: string

    The name of the ML application that the agent is orchestrating. If not provided, the default value will be set to mlApp provided during initialization, or DD_LLMOBS_ML_APP.

    modelName?: string

    The name of the invoked LLM or embedding model. Only used on llm and embedding spans.

    modelProvider?: string

    The name of the invoked LLM or embedding model provider. Only used on llm and embedding spans. If not provided for LLM or embedding spans, a default value of 'custom' will be set.

    references?: Reference[]

    an array of Reference instances, each pointing to a causal parent SpanContext. If specified, fields.childOf must be unspecified.

    sessionId?: string

    The ID of the underlying user session. Required for tracking sessions.

    startTime?: number

    a manually specified start time for the created Span object. The time should be specified in milliseconds as Unix timestamp. Decimal value are supported to represent time values with sub-millisecond accuracy.

    tags?: { [key: string]: any }

    set of key-value pairs which will be set as tags on the newly created Span. Ownership of the object is passed to the created span for efficiency reasons (the caller should not modify this object after calling startSpan).

    Settings

    Member Visibility

    On This Page

    Properties