dd-trace
    Preparing search index...

    Interface LLMObsSpanOptions

    interface LLMObsSpanOptions {
        childOf?: SpanContext | Span | null;
        integrationName?: string;
        kind: spanKind;
        mlApp?: string;
        modelName?: string;
        modelProvider?: string;
        sessionId?: string;
    }

    Hierarchy (View Summary)

    Index

    Properties

    childOf? integrationName? kind mlApp? modelName? modelProvider? sessionId?

    Properties

    childOf?: SpanContext | Span | null

    Set childOf to 'null' to create a root span without a parent, even when a parent span exists in the current async context. If 'undefined' the parent will be inferred from the existing async context.

    integrationName?: string

    Optional name of the integration that crated this span.

    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.

    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.

    sessionId?: string

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

    Settings

    Member Visibility

    On This Page

    Properties