Update notebook and clean up client ergonomics (#7394)

Author: anticorrelator

packages/phoenix-client/src/phoenix/client/resources/spans/__init__.py

@@ -120,7 +120,7 @@ def get_span_annotations_dataframe(
         *,
         spans_dataframe: Optional["pd.DataFrame"] = None,
         span_ids: Optional[Iterable[str]] = None,
-        project: str,
+        project: str = "default",
         limit: int = 1000,
         timeout: Optional[int] = DEFAULT_TIMEOUT_IN_SECONDS,
     ) -> "pd.DataFrame":
@@ -175,7 +175,7 @@ def get_span_annotations_dataframe(
         annotations: list[v1.SpanAnnotation] = []
         path = f"v1/projects/{project}/span_annotations"
 
-        for i in range(len(span_ids_list), _MAX_SPAN_IDS_PER_REQUEST):
+        for i in range(0, len(span_ids_list), _MAX_SPAN_IDS_PER_REQUEST):
             batch_ids = span_ids_list[i : i + _MAX_SPAN_IDS_PER_REQUEST]
             cursor: Optional[str] = None
             while True:
@@ -201,7 +201,9 @@ def get_span_annotations_dataframe(
                 if not cursor:
                     break  # finished paginating this batch
 
-        return pd.DataFrame(annotations)
+        df = pd.DataFrame(annotations)
+        df.set_index("span_id", inplace=True)
+        return df
 
     def get_span_annotations(
         self,
@@ -416,7 +418,7 @@ async def get_span_annotations_dataframe(
         annotations: list[v1.SpanAnnotation] = []
         path = f"v1/projects/{project}/span_annotations"
 
-        for i in range(len(span_ids_list), _MAX_SPAN_IDS_PER_REQUEST):
+        for i in range(0, len(span_ids_list), _MAX_SPAN_IDS_PER_REQUEST):
             batch_ids = span_ids_list[i : i + _MAX_SPAN_IDS_PER_REQUEST]
             cursor: Optional[str] = None
             while True:
@@ -441,7 +443,9 @@ async def get_span_annotations_dataframe(
                 if not cursor:
                     break
 
-        return pd.DataFrame(annotations)
+        df = pd.DataFrame(annotations)
+        df.set_index("span_id", inplace=True)
+        return df
 
     async def get_span_annotations(
         self,

tutorials/human_feedback/chatbot_with_human_feedback.ipynb

@@ -34,7 +34,7 @@
   },
   {
    "cell_type": "code",
-   "execution_count": null,
+   "execution_count": 1,
    "metadata": {},
    "outputs": [],
    "source": [
@@ -89,7 +89,7 @@
   },
   {
    "cell_type": "code",
-   "execution_count": null,
+   "execution_count": 2,
    "metadata": {},
    "outputs": [],
    "source": [
@@ -114,7 +114,7 @@
   },
   {
    "cell_type": "code",
-   "execution_count": null,
+   "execution_count": 4,
    "metadata": {},
    "outputs": [],
    "source": [
@@ -222,11 +222,57 @@
     "# Display the chat interface\n",
     "display(chat_history, input_box, send_button)"
    ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "## Analyze feedback using the Phoenix Client\n",
+    "\n",
+    "We can use the Phoenix client to pull the annotated spans. By combining `get_spans_dataframe`\n",
+    "and `get_span_annotations_dataframe` we can create a dataframe of all annotations alongside\n",
+    "span data for analysis!"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": 1,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "spans_df = client.spans.get_spans_dataframe(project_name=\"default\")\n",
+    "annotations_df = client.spans.get_span_annotations_dataframe(\n",
+    "    spans_dataframe=spans_df, project=\"default\"\n",
+    ")"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "annotations_df.join(spans_df, how=\"inner\", lsuffix=\"_annotation\", rsuffix=\"_span\")"
+   ]
   }
  ],
  "metadata": {
+  "kernelspec": {
+   "display_name": "dev",
+   "language": "python",
+   "name": "python3"
+  },
   "language_info": {
-   "name": "python"
+   "codemirror_mode": {
+    "name": "ipython",
+    "version": 3
+   },
+   "file_extension": ".py",
+   "mimetype": "text/x-python",
+   "name": "python",
+   "nbconvert_exporter": "python",
+   "pygments_lexer": "ipython3",
+   "version": "3.11.9"
   }
  },
  "nbformat": 4,