Langfuse JS/TS SDKs
    Preparing search index...

    Interface CreateCommentRequest

    This file was auto-generated by Fern from our API Definition.

    interface CreateCommentRequest {
        authorUserId?: string;
        content: string;
        dataField?: string;
        objectId: string;
        objectType: string;
        path?: string[];
        projectId: string;
        rangeEnd?: number[];
        rangeStart?: number[];
    }
    Index

    Properties

    authorUserId? content dataField? objectId objectType path? projectId rangeEnd? rangeStart?

    Properties

    authorUserId?: string

    The id of the user who created the comment.

    content

    content: string

    The content of the comment. May include markdown. Currently limited to 5000 characters.

    dataField?: string

    For inline comments on IO, specifies which field (input, output, or metadata). Must be set together with path, rangeStart, and rangeEnd.

    objectId: string

    The id of the object to attach the comment to. If this does not reference a valid existing object, an error will be thrown.

    objectType: string

    The type of the object to attach the comment to (trace, observation, session, prompt).

    path?: string[]

    JSON Path expressions specifying comment location within the dataField. Must have same length as rangeStart and rangeEnd.

    projectId: string

    The id of the project to attach the comment to.

    rangeEnd?: number[]

    End character offsets (exclusive, UTF-16 code units) for each path entry.

    rangeStart?: number[]

    Start character offsets (inclusive, UTF-16 code units) for each path entry.

    Settings

    Member Visibility

    On This Page

    Properties