Files
awesome-copilot/skills/phoenix-tracing/references/annotations-overview.md
Jim Bennett d79183139a Add Arize and Phoenix LLM observability skills (#1204)
* Add 9 Arize LLM observability skills

Add skills for Arize AI platform covering trace export, instrumentation,
datasets, experiments, evaluators, AI provider integrations, annotations,
prompt optimization, and deep linking to the Arize UI.

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>

* Add 3 Phoenix AI observability skills

Add skills for Phoenix (Arize open-source) covering CLI debugging,
LLM evaluation workflows, and OpenInference tracing/instrumentation.

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>

* Ignoring intentional bad spelling

* Fix CI: remove .DS_Store from generated skills README and add codespell ignore

Remove .DS_Store artifact from winmd-api-search asset listing in generated
README.skills.md so it matches the CI Linux build output. Add queston to
codespell ignore list (intentional misspelling example in arize-dataset skill).

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>

* Add arize-ax and phoenix plugins

Bundle the 9 Arize skills into an arize-ax plugin and the 3 Phoenix
skills into a phoenix plugin for easier installation as single packages.

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>

* Fix skill folder structures to match source repos

Move arize supporting files from references/ to root level and rename
phoenix references/ to rules/ to exactly match the original source
repository folder structures.

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>

* Fixing file locations

* Fixing readme

---------

Co-authored-by: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
2026-04-02 09:58:55 +11:00

3.8 KiB

Annotations Overview

Annotations allow you to add human or automated feedback to traces, spans, documents, and sessions. Annotations are essential for evaluation, quality assessment, and building training datasets.

Annotation Types

Phoenix supports four types of annotations:

Type Target Purpose Example Use Case
Span Annotation Individual span Feedback on a specific operation "This LLM response was accurate"
Document Annotation Document within a RETRIEVER span Feedback on retrieved document relevance "This document was not helpful"
Trace Annotation Entire trace Feedback on end-to-end interaction "User was satisfied with result"
Session Annotation User session Feedback on multi-turn conversation "Session ended successfully"

Annotation Fields

Every annotation has these fields:

Required Fields

Field Type Description
Entity ID String ID of the target entity (span_id, trace_id, session_id, or document_position)
name String Annotation name/label (e.g., "quality", "relevance", "helpfulness")

Result Fields (At Least One Required)

Field Type Description
label String (optional) Categorical value (e.g., "good", "bad", "relevant", "irrelevant")
score Float (optional) Numeric value (typically 0-1, but can be any range)
explanation String (optional) Free-text explanation of the annotation

At least one of label, score, or explanation must be provided.

Optional Fields

Field Type Description
annotator_kind String Who created this annotation: "HUMAN", "LLM", or "CODE" (default: "HUMAN")
identifier String Unique identifier for upsert behavior (updates existing if same name+entity+identifier)
metadata Object Custom metadata as key-value pairs

Annotator Kinds

Kind Description Example
HUMAN Manual feedback from a person User ratings, expert labels
LLM Automated feedback from an LLM GPT-4 evaluating response quality
CODE Automated feedback from code Rule-based checks, heuristics

Examples

Quality Assessment:

  • quality - Overall quality (label: good/fair/poor, score: 0-1)
  • correctness - Factual accuracy (label: correct/incorrect, score: 0-1)
  • helpfulness - User satisfaction (label: helpful/not_helpful, score: 0-1)

RAG-Specific:

  • relevance - Document relevance to query (label: relevant/irrelevant, score: 0-1)
  • faithfulness - Answer grounded in context (label: faithful/unfaithful, score: 0-1)

Safety:

  • toxicity - Contains harmful content (score: 0-1)
  • pii_detected - Contains personally identifiable information (label: yes/no)