feat(DOCUMENTATION): :bookmark: Add Jupyter notebook for API interaction, including functions for text generation and summarization with example usage.

test.ipynb

@@ -0,0 +1,154 @@
+{
+ "cells": [
+  {
+   "cell_type": "code",
+   "execution_count": 1,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "import requests"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": 3,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "# API configuration\n",
+    "API_URL = \"https://maximofn-iriusrisktestchallenge.hf.space\"\n",
+    "API_KEY = \"your_api_key\""
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": 4,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "# Headers for authentication\n",
+    "headers = {\n",
+    "    \"X-API-Key\": API_KEY,\n",
+    "    \"Content-Type\": \"application/json\"\n",
+    "}"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": 5,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "# Generate text\n",
+    "def generate_text(query, thread_id=\"default\", system_prompt=None):\n",
+    "    url = f\"{API_URL}/generate\"\n",
+    "    \n",
+    "    data = {\n",
+    "        \"query\": query,\n",
+    "        \"thread_id\": thread_id\n",
+    "    }\n",
+    "    \n",
+    "    # Add system prompt if provided\n",
+    "    if system_prompt:\n",
+    "        data[\"system_prompt\"] = system_prompt\n",
+    "    \n",
+    "    try:\n",
+    "        response = requests.post(url, json=data, headers=headers)\n",
+    "        if response.status_code == 200:\n",
+    "            result = response.json()\n",
+    "            return result[\"generated_text\"]\n",
+    "        else:\n",
+    "            print(f\"Error: {response.status_code}\")\n",
+    "            print(f\"Details: {response.text}\")\n",
+    "            return None\n",
+    "    except Exception as e:\n",
+    "        print(f\"Request failed: {str(e)}\")\n",
+    "        return None"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "# Example with custom thread and system prompt\n",
+    "result = generate_text(\n",
+    "    query=\"Explain object-oriented programming\",\n",
+    "    thread_id=\"programming_tutorial\",\n",
+    "    system_prompt=\"You are a programming teacher. Explain concepts in simple terms.\"\n",
+    ")"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": 6,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "# Summarize text\n",
+    "def summarize_text(text, max_length=200, thread_id=\"default\"):\n",
+    "    url = f\"{API_URL}/summarize\"\n",
+    "    \n",
+    "    data = {\n",
+    "        \"text\": text,\n",
+    "        \"max_length\": max_length,\n",
+    "        \"thread_id\": thread_id\n",
+    "    }\n",
+    "    \n",
+    "    try:\n",
+    "        response = requests.post(url, json=data, headers=headers)\n",
+    "        if response.status_code == 200:\n",
+    "            result = response.json()\n",
+    "            return result[\"summary\"]\n",
+    "        else:\n",
+    "            print(f\"Error: {response.status_code}\")\n",
+    "            print(f\"Details: {response.text}\")\n",
+    "            return None\n",
+    "    except Exception as e:\n",
+    "        print(f\"Request failed: {str(e)}\")\n",
+    "        return None"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "# Example usage\n",
+    "text_to_summarize = \"\"\"\n",
+    "Python is a high-level, interpreted programming language created by Guido van Rossum \n",
+    "and released in 1991. Python's design philosophy emphasizes code readability with \n",
+    "the use of significant whitespace. Its language constructs and object-oriented \n",
+    "approach aim to help programmers write clear, logical code for small and large-scale projects.\n",
+    "\"\"\"\n",
+    "\n",
+    "summary = summarize_text(text_to_summarize, max_length=50)\n",
+    "if summary:\n",
+    "    print(\"Summary:\", summary)"
+   ]
+  }
+ ],
+ "metadata": {
+  "kernelspec": {
+   "display_name": "base",
+   "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,
+ "nbformat_minor": 2
+}