Algolia/Algolia_Add_or_Replace_all_attributes_in_single_record.ipynb

{
 "cells": [
  {
   "cell_type": "markdown",
   "id": "11d08c61-173e-4247-8a82-3893b9579c03",
   "metadata": {
    "papermill": {},
    "tags": []
   },
   "source": [
    "<img width=\"8%\" alt=\"Algolia.png\" src=\"https://raw.githubusercontent.com/jupyter-naas/awesome-notebooks/master/.github/assets/logos/Algolia.png\" style=\"border-radius: 15%\">"
   ]
  },
  {
   "cell_type": "markdown",
   "id": "6a7dc56a-a769-4fcf-add5-fe7c6d976784",
   "metadata": {
    "papermill": {},
    "tags": []
   },
   "source": [
    "# Algolia - Add or Replace all attributes in a single record\n",
    "<a href=\"https://bit.ly/3JyWIk6\">Give Feedback</a> | <a href=\"https://github.com/jupyter-naas/awesome-notebooks/issues/new?assignees=&labels=bug&template=bug_report.md&title=Algolia+-+Add+or+Replace+all+attributes+in+a+single+record:+Error+short+description\">Bug report</a>"
   ]
  },
  {
   "cell_type": "markdown",
   "id": "7c5b1cd2-a7c3-4e7a-b7ed-670542dbe124",
   "metadata": {
    "papermill": {},
    "tags": []
   },
   "source": [
    "**Tags:** #algolia #python #api #index #object #save #update #add"
   ]
  },
  {
   "cell_type": "markdown",
   "id": "5cb77dcb-252c-448a-8c54-1b3cecc566e0",
   "metadata": {
    "papermill": {},
    "tags": []
   },
   "source": [
    "**Author:** [Florent Ravenel](https://www.linkedin.com/in/florent-ravenel/)"
   ]
  },
  {
   "cell_type": "markdown",
   "id": "be434cf7-9e1f-481f-8074-ced50180d26e",
   "metadata": {
    "papermill": {},
    "tags": []
   },
   "source": [
    "**Last update:** 2023-06-15 (Created: 2023-06-15)"
   ]
  },
  {
   "cell_type": "markdown",
   "id": "157047ba-776b-430e-add1-5f72083ead65",
   "metadata": {
    "papermill": {},
    "tags": []
   },
   "source": [
    "**Description:** This notebook shows how to add new record (object) to an index or replace existing record with an updated set of attributes.\n",
    "This method redefines all of a record’s attributes (except its objectID). In other words, it fully replaces an existing record."
   ]
  },
  {
   "cell_type": "markdown",
   "id": "60d5b331-15e2-4812-b086-13dd192ac2fa",
   "metadata": {
    "papermill": {},
    "tags": []
   },
   "source": [
    "**References:**\n",
    "- [Algolia API Reference](https://www.algolia.com/doc/api-reference/api-methods/save-objects/)\n",
    "- [Algolia Python Client](https://github.com/algolia/algoliasearch-client-python)"
   ]
  },
  {
   "cell_type": "markdown",
   "id": "554e5d73-9fd4-4e6c-9ff0-7758851faa90",
   "metadata": {
    "papermill": {},
    "tags": []
   },
   "source": [
    "## Input"
   ]
  },
  {
   "cell_type": "markdown",
   "id": "7df6b816-2392-4301-855a-f49278e5837d",
   "metadata": {
    "papermill": {},
    "tags": []
   },
   "source": [
    "### Import libraries"
   ]
  },
  {
   "cell_type": "code",
   "execution_count": null,
   "id": "aa0e3e6f-1260-4452-8abf-7c084e26c8a4",
   "metadata": {
    "papermill": {},
    "tags": []
   },
   "outputs": [],
   "source": [
    "try:\n",
    "    from algoliasearch.search_client import SearchClient\n",
    "except:\n",
    "    !pip install algoliasearch --user\n",
    "    from algoliasearch.search_client import SearchClient\n",
    "import naas"
   ]
  },
  {
   "cell_type": "markdown",
   "id": "e1b7463d-b2ae-47ae-8ca4-97ae1fe801db",
   "metadata": {
    "papermill": {},
    "tags": []
   },
   "source": [
    "### Setup Variables\n",
    "- `app_id`: Algolia application ID. [Get your credentials](https://dashboard.algolia.com/account/api-keyss)\n",
    "- `api_key`: Algolia API key. [Get your credentials](https://dashboard.algolia.com/account/api-keys)\n",
    "- `index_name`: Algolia index name\n",
    "- `single_object`: An dict with keys and values to be added or updated in the Algolia index. This dict must contain a unique identifier field called \"objectID\". If the \"objectID\" field is not present, Algolia will automatically generate a new unique identifier for the object."
   ]
  },
  {
   "cell_type": "code",
   "execution_count": null,
   "id": "cfa97168-63eb-4e8c-89c3-0a5d26f47740",
   "metadata": {
    "papermill": {},
    "tags": []
   },
   "outputs": [],
   "source": [
    "app_id = naas.secret.get(\"ALGOLIA_APP_ID\") or \"<YOUR_APP_ID>\"\n",
    "api_key = naas.secret.get(\"ALGOLIA_API_KEY\") or \"<YOUR_API_KEY>\"\n",
    "index_name = \"<YOUR_INDEX_NAME>\"\n",
    "single_object = {'firstname': 'Jimmie', 'lastname': 'Barninger', 'objectID': 'myID1'},"
   ]
  },
  {
   "cell_type": "markdown",
   "id": "8871707b-c02f-4800-ae8e-fd551aa0717f",
   "metadata": {
    "papermill": {},
    "tags": []
   },
   "source": [
    "## Model"
   ]
  },
  {
   "cell_type": "markdown",
   "id": "dc30c4a0-d4df-42d5-a3c9-084f31b38523",
   "metadata": {
    "papermill": {},
    "tags": []
   },
   "source": [
    "### Connect to Algolia and initialize index"
   ]
  },
  {
   "cell_type": "code",
   "execution_count": null,
   "id": "def6224a-8fb4-42bf-a882-08e26ff6e3e2",
   "metadata": {
    "papermill": {},
    "tags": []
   },
   "outputs": [],
   "source": [
    "# Initialize the Algolia client\n",
    "client = SearchClient.create(app_id, api_key)\n",
    "\n",
    "# Initialize the Algolia index\n",
    "index = client.init_index(index_name)"
   ]
  },
  {
   "cell_type": "markdown",
   "id": "88605bbe-4b30-4b3e-877c-ace2a00a0073",
   "metadata": {
    "papermill": {},
    "tags": []
   },
   "source": [
    "## Output"
   ]
  },
  {
   "cell_type": "markdown",
   "id": "dfc29d71-db3a-4c28-a046-ca4333a42f64",
   "metadata": {
    "papermill": {},
    "tags": []
   },
   "source": [
    "### Add or Replace all attributes in a single record"
   ]
  },
  {
   "cell_type": "code",
   "execution_count": null,
   "id": "1f9f3614-4ae1-4dfa-aa43-15dad392c81e",
   "metadata": {
    "papermill": {},
    "tags": []
   },
   "outputs": [],
   "source": [
    "index.save_object(single_object)"
   ]
  }
 ],
 "metadata": {
  "kernelspec": {
   "display_name": "Python 3",
   "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.9.6"
  },
  "naas": {
   "notebook_id": "5d2df023819411f69ec17f94b0bfde745eb6a1292e39f5cded170e4c053333f6",
   "notebook_path": "Algolia/Algolia_Add_or_Replace_all_attributes_in_single_record.ipynb"
  },
  "papermill": {
   "default_parameters": {},
   "environment_variables": {},
   "parameters": {},
   "version": "2.4.0"
  },
  "widgets": {
   "application/vnd.jupyter.widget-state+json": {
    "state": {},
    "version_major": 2,
    "version_minor": 0
   }
  }
 },
 "nbformat": 4,
 "nbformat_minor": 5
}