moved to api_client

Author: jjmachan

README.md

@@ -22,6 +22,23 @@ $ pip install ragas_experimental
 
 ## Getting Started
 
-First lets init a
+First do signup to [beta.app.ragas.io](https://beta.app.ragas.io/) and
+generate the App Token and put it in the as the env variable
+`RAGAS_APP_TOKEN`.
+
+``` python
+import os
+# ideally you load this from a .env file so as to not commit it to the repo
+os.environ["RAGAS_APP_TOKEN"] = "api-key"
+```
+
+Now lets init a
 [`Project`](https://explodinggradients.github.io/ragas_experimental/project/core.html#project)
-from notion.
+in the App
+
+``` python
+from ragas_experimental import Project
+
+project = Project.create("my-project")
+project
+```

nbs/dataset.ipynb

@@ -279,7 +279,7 @@
     }
    ],
    "source": [
-    "p = Project(project_id=\"3d9b529b-c23f-4e87-8a26-dd1923749aa7\", ragas_app_client=ragas_api_client)\n",
+    "p = Project(project_id=\"3d9b529b-c23f-4e87-8a26-dd1923749aa7\", ragas_api_client=ragas_api_client)\n",
     "test_dataset = p.create_dataset(name=\"TestModel_with_long_text\", model=TestModel)\n",
     "test_dataset"
    ]

nbs/index.ipynb

@@ -62,7 +62,7 @@
   },
   {
    "cell_type": "code",
-   "execution_count": 1,
+   "execution_count": null,
    "metadata": {},
    "outputs": [],
    "source": [
@@ -93,21 +93,9 @@
  ],
  "metadata": {
   "kernelspec": {
-   "display_name": ".venv",
+   "display_name": "python3",
    "language": "python",
    "name": "python3"
-  },
-  "language_info": {
-   "codemirror_mode": {
-    "name": "ipython",
-    "version": 3
-   },
-   "file_extension": ".py",
-   "mimetype": "text/x-python",
-   "name": "python",
-   "nbconvert_exporter": "python",
-   "pygments_lexer": "ipython3",
-   "version": "3.12.8"
   }
  },
  "nbformat": 4,

nbs/project/core.ipynb

@@ -71,13 +71,13 @@
     "    def __init__(\n",
     "        self,\n",
     "        project_id: str,\n",
-    "        ragas_app_client: t.Optional[RagasApiClient] = None,\n",
+    "        ragas_api_client: t.Optional[RagasApiClient] = None,\n",
     "    ):\n",
     "        self.project_id = project_id\n",
-    "        if ragas_app_client is None:\n",
+    "        if ragas_api_client is None:\n",
     "            self._ragas_api_client = RagasApiClientFactory.create()\n",
     "        else:\n",
-    "            self._ragas_api_client = ragas_app_client\n",
+    "            self._ragas_api_client = ragas_api_client\n",
     "\n",
     "        # create the project\n",
     "        try:\n",
@@ -94,12 +94,12 @@
     "        cls,\n",
     "        name: str,\n",
     "        description: str = \"\",\n",
-    "        ragas_app_client: t.Optional[RagasApiClient] = None,\n",
+    "        ragas_api_client: t.Optional[RagasApiClient] = None,\n",
     "    ):\n",
-    "        ragas_app_client = RagasApiClientFactory.create()\n",
-    "        sync_version = async_to_sync(ragas_app_client.create_project)\n",
+    "        ragas_api_client = RagasApiClientFactory.create()\n",
+    "        sync_version = async_to_sync(ragas_api_client.create_project)\n",
     "        new_project = sync_version(title=name, description=description)\n",
-    "        return cls(new_project[\"id\"], ragas_app_client)\n",
+    "        return cls(new_project[\"id\"], ragas_api_client)\n",
     "\n",
     "    def delete(self):\n",
     "        sync_version = async_to_sync(self._ragas_api_client.delete_project)\n",
@@ -153,22 +153,22 @@
    "source": [
     "# | export\n",
     "@patch(cls_method=True)\n",
-    "def get(cls: Project, name: str, ragas_app_client: t.Optional[RagasApiClient] = None) -> Project:\n",
+    "def get(cls: Project, name: str, ragas_api_client: t.Optional[RagasApiClient] = None) -> Project:\n",
     "    \"\"\"Get an existing project by name.\"\"\"\n",
     "    # Search for project with given name\n",
-    "    if ragas_app_client is None:\n",
-    "        ragas_app_client = RagasApiClientFactory.create()\n",
+    "    if ragas_api_client is None:\n",
+    "        ragas_api_client = RagasApiClientFactory.create()\n",
     "\n",
     "    # get the project by name\n",
-    "    sync_version = async_to_sync(ragas_app_client.get_project_by_name)\n",
+    "    sync_version = async_to_sync(ragas_api_client.get_project_by_name)\n",
     "    project_info = sync_version(\n",
     "        project_name=name\n",
     "    )\n",
     "\n",
     "    # Return Project instance\n",
     "    return Project(\n",
     "        project_id=project_info[\"id\"],\n",
-    "        ragas_app_client=ragas_app_client,\n",
+    "        ragas_api_client=ragas_api_client,\n",
     "    )"
    ]
   },

ragas_experimental/project/core.py

@@ -25,13 +25,13 @@ class Project:
     def __init__(
         self,
         project_id: str,
-        ragas_app_client: t.Optional[RagasApiClient] = None,
+        ragas_api_client: t.Optional[RagasApiClient] = None,
     ):
         self.project_id = project_id
-        if ragas_app_client is None:
+        if ragas_api_client is None:
             self._ragas_api_client = RagasApiClientFactory.create()
         else:
-            self._ragas_api_client = ragas_app_client
+            self._ragas_api_client = ragas_api_client
 
         # create the project
         try:
@@ -48,12 +48,12 @@ def create(
         cls,
         name: str,
         description: str = "",
-        ragas_app_client: t.Optional[RagasApiClient] = None,
+        ragas_api_client: t.Optional[RagasApiClient] = None,
     ):
-        ragas_app_client = RagasApiClientFactory.create()
-        sync_version = async_to_sync(ragas_app_client.create_project)
+        ragas_api_client = RagasApiClientFactory.create()
+        sync_version = async_to_sync(ragas_api_client.create_project)
         new_project = sync_version(title=name, description=description)
-        return cls(new_project["id"], ragas_app_client)
+        return cls(new_project["id"], ragas_api_client)
 
     def delete(self):
         sync_version = async_to_sync(self._ragas_api_client.delete_project)
@@ -66,21 +66,21 @@ def __repr__(self):
 # %% ../../nbs/project/core.ipynb 8
 @patch(cls_method=True)
 def get(
-    cls: Project, name: str, ragas_app_client: t.Optional[RagasApiClient] = None
+    cls: Project, name: str, ragas_api_client: t.Optional[RagasApiClient] = None
 ) -> Project:
     """Get an existing project by name."""
     # Search for project with given name
-    if ragas_app_client is None:
-        ragas_app_client = RagasApiClientFactory.create()
+    if ragas_api_client is None:
+        ragas_api_client = RagasApiClientFactory.create()
 
     # get the project by name
-    sync_version = async_to_sync(ragas_app_client.get_project_by_name)
+    sync_version = async_to_sync(ragas_api_client.get_project_by_name)
     project_info = sync_version(project_name=name)
 
     # Return Project instance
     return Project(
         project_id=project_info["id"],
-        ragas_app_client=ragas_app_client,
+        ragas_api_client=ragas_api_client,
     )
 
 # %% ../../nbs/project/core.ipynb 12