Arize Phoenix TS
    Preparing search index...

    Function toDocumentAnnotationData

    • Convert a DocumentAnnotation to the API format

      Parameters

      Returns {
          annotator_kind: "LLM" | "CODE" | "HUMAN";
          document_position: number;
          identifier?: string;
          metadata?: { [key: string]: unknown } | null;
          name: string;
          result?:
              | {
                  explanation?: string
                  | null;
                  label?: string | null;
                  score?: number | null;
              }
              | null;
          span_id: string;
      }

      • annotator_kind: "LLM" | "CODE" | "HUMAN"

        Annotator Kind

        The kind of annotator used for the annotation

      • document_position: number

        Document Position

        A 0 based index of the document. E.x. the first document during retrieval is 0

      • Optionalidentifier?: string

        Identifier

        The identifier of the annotation. If provided, the annotation will be updated if it already exists.
      • Optionalmetadata?: { [key: string]: unknown } | null

        Metadata

        Metadata for the annotation

      • name: string

        Name

        The name of the annotation

      • Optionalresult?:
            | {
                explanation?: string
                | null;
                label?: string | null;
                score?: number | null;
            }
            | null

        The result of the annotation

      • span_id: string

        Span Id

        OpenTelemetry Span ID (hex format w/o 0x prefix)

    Settings

    Member Visibility