caller.ipynb

{
 "cells": [
  {
   "cell_type": "markdown",
   "metadata": {},
   "source": [
    "# FastAPI Endpoint Caller\n",
    "\n",
    "## Endpoint Configuration and Helper Functions\n",
    "This section defines the base URL, endpoint mappings, and helper functions to interact with our FastAPI application. \n",
    "It includes functions for all CRUD operations and AI-powered answers.\n",
    "\n",
    "Key components:\n",
    "- `BASE_URL`: The root URL of our FastAPI server\n",
    "- `ENDPOINTS`: Dictionary mapping operation names to their endpoint URLs\n",
    "- Helper functions for each API operation\n"
   ]
  },
  {
   "cell_type": "code",
   "execution_count": 14,
   "metadata": {},
   "outputs": [],
   "source": [
    "import requests\n",
    "\n",
    "# Base URL for the API\n",
    "BASE_URL = \"http://localhost:8000\"\n",
    "\n",
    "# Collection of endpoint strings\n",
    "ENDPOINTS = {\n",
    "    \"get_all\": \"/qaa/get-all-qaa\",\n",
    "    \"get_by_id\": \"/qaa/get-qaa-by-id/{id}\",\n",
    "    \"create\": \"/qaa/create-question\",\n",
    "    \"update_answer\": \"/qaa/edit-qaa-by-id/{id}/answer\",\n",
    "    \"update_question\": \"/qaa/edit-qaa-by-id/{id}/question\",\n",
    "    \"delete_by_id\": \"/qaa/delete-qaa-by-id/{id}\",\n",
    "    \"delete_all\": \"/qaa/delete-all-qaa\",\n",
    "    \"ai_answer\": \"/langchain/{id}/ai-answer\"\n",
    "}"
   ]
  },
  {
   "cell_type": "markdown",
   "metadata": {},
   "source": [
    "# Function Definitions\n",
    "\n",
    "## Database Operations\n",
    "- `get_all_qaa()`: \n",
    "  - Retrieves all question-answer pairs from the database\n",
    "  - Returns: List of QAA objects\n",
    "  - Endpoint: `GET /qaa/get-all-qaa`\n",
    "\n",
    "- `get_qaa_by_id(qaa_id: int)`:\n",
    "  - Retrieves a specific QA pair by its ID\n",
    "  - Parameters: `qaa_id` - The unique identifier\n",
    "  - Returns: Single QAA object\n",
    "  - Endpoint: `GET /qaa/get-qaa-by-id/{id}`\n",
    "\n",
    "## Question Management\n",
    "- `create_question(question: str)`:\n",
    "  - Creates a new question in the database\n",
    "  - Parameters: `question` - The question text\n",
    "  - Returns: Created QAA object\n",
    "  - Endpoint: `POST /qaa/create-question`\n",
    "\n",
    "- `update_question(qaa_id: int, question: str)`:\n",
    "  - Updates an existing question\n",
    "  - Parameters: \n",
    "    - `qaa_id` - The question ID\n",
    "    - `question` - New question text\n",
    "  - Returns: Updated QAA object\n",
    "  - Endpoint: `PUT /qaa/edit-qaa-by-id/{id}/question`\n",
    "\n",
    "## Answer Management\n",
    "- `update_answer(qaa_id: int, answer: str)`:\n",
    "  - Updates the answer for a question\n",
    "  - Parameters:\n",
    "    - `qaa_id` - The question ID\n",
    "    - `answer` - New answer text\n",
    "  - Returns: Updated QAA object\n",
    "  - Endpoint: `PUT /qaa/edit-qaa-by-id/{id}/answer`\n",
    "\n",
    "- `get_ai_answer(qaa_id: int)`:\n",
    "  - Generates an AI answer using OpenAI\n",
    "  - Parameters: `qaa_id` - The question ID\n",
    "  - Returns: Updated QAA object with AI response\n",
    "  - Endpoint: `PUT /langchain/{id}/ai-answer`\n",
    "\n",
    "## Deletion Operations\n",
    "- `delete_qaa(qaa_id: int)`:\n",
    "  - Deletes a specific QA pair\n",
    "  - Parameters: `qaa_id` - The ID to delete\n",
    "  - Returns: HTTP status code\n",
    "  - Endpoint: `DELETE /qaa/delete-qaa-by-id/{id}`\n",
    "\n",
    "- `delete_all_qaa()`:\n",
    "  - Deletes all QA pairs from database\n",
    "  - Returns: HTTP status code\n",
    "  - Endpoint: `DELETE /qaa/delete-all-qaa`"
   ]
  },
  {
   "cell_type": "code",
   "execution_count": null,
   "metadata": {},
   "outputs": [],
   "source": [
    "# Helper functions for each endpoint\n",
    "def get_all_qaa():\n",
    "    response = requests.get(f\"{BASE_URL}{ENDPOINTS['get_all']}\")\n",
    "    return response.json()\n",
    "\n",
    "def get_qaa_by_id(qaa_id: int):\n",
    "    response = requests.get(f\"{BASE_URL}{ENDPOINTS['get_by_id']}\".format(id=qaa_id))\n",
    "    return response.json()\n",
    "\n",
    "def create_question(question: str):\n",
    "    response = requests.post(\n",
    "        f\"{BASE_URL}{ENDPOINTS['create']}\", \n",
    "        json={\"question\": question}\n",
    "    )\n",
    "    return response.json()\n",
    "\n",
    "def update_answer(qaa_id: int, answer: str):\n",
    "    response = requests.put(\n",
    "        f\"{BASE_URL}{ENDPOINTS['update_answer']}\".format(id=qaa_id),\n",
    "        json={\"answer\": answer}\n",
    "    )\n",
    "    return response.json()\n",
    "\n",
    "def update_question(qaa_id: int, question: str):\n",
    "    response = requests.put(\n",
    "        f\"{BASE_URL}{ENDPOINTS['update_question']}\".format(id=qaa_id),\n",
    "        json={\"question\": question}\n",
    "    )\n",
    "    return response.json()\n",
    "\n",
    "def delete_qaa(qaa_id: int):\n",
    "    response = requests.delete(f\"{BASE_URL}{ENDPOINTS['delete_by_id']}\".format(id=qaa_id))\n",
    "    return response.status_code\n",
    "\n",
    "def delete_all_qaa():\n",
    "    response = requests.delete(f\"{BASE_URL}{ENDPOINTS['delete_all']}\")\n",
    "    return response.status_code\n",
    "\n",
    "def get_ai_answer(qaa_id: int):\n",
    "    response = requests.put(f\"{BASE_URL}{ENDPOINTS['ai_answer']}\".format(id=qaa_id))\n",
    "    return response.json()"
   ]
  },
  {
   "cell_type": "markdown",
   "metadata": {},
   "source": [
    "## Testing the Endpoints\n",
    "Below are example uses of each endpoint function. Each example demonstrates how to:\n",
    "1. Create a new question\n",
    "2. Get an AI-generated answer\n",
    "3. Retrieve all QA pairs\n",
    "4. Get a specific QA pair\n",
    "5. Update answers and questions\n",
    "6. Delete entries\n",
    "\n",
    "Run each cell separately to test different operations."
   ]
  },
  {
   "cell_type": "code",
   "execution_count": null,
   "metadata": {},
   "outputs": [],
   "source": [
    "# Example usage:\n",
    "\n",
    "# Create a new question\n",
    "new_question = create_question(\"What is the capital of France?\")\n",
    "print(\"Created question:\", new_question)\n",
    "\n",
    "# Get AI answer for the question\n",
    "ai_response = get_ai_answer(new_question['id'])\n",
    "print(\"\\nAI Answer:\", ai_response)\n",
    "\n",
    "# Get all QA pairs\n",
    "all_qaa = get_all_qaa()\n",
    "print(\"\\nAll QA pairs:\", all_qaa)\n",
    "\n",
    "# Get specific QA pair\n",
    "specific_qaa = get_qaa_by_id(new_question['id'])\n",
    "print(\"\\nSpecific QA:\", specific_qaa)\n",
    "\n",
    "# Update answer\n",
    "updated = update_answer(new_question['id'], \"The capital of France is Paris.\")\n",
    "print(\"\\nUpdated answer:\", updated)\n",
    "\n",
    "# Update question\n",
    "updated = update_question(new_question['id'], \"What is the capital city of France?\")\n",
    "print(\"\\nUpdated question:\", updated)\n",
    "\n",
    "# Delete specific QA\n",
    "delete_status = delete_qaa(new_question['id'])\n",
    "print(\"\\nDelete status:\", delete_status)"
   ]
  }
 ],
 "metadata": {
  "kernelspec": {
   "display_name": ".venv",
   "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.7"
  }
 },
 "nbformat": 4,
 "nbformat_minor": 2
}