aoai-rag/notebooks/05_AzureAISearch_LangChain.ipynb

{
 "cells": [
  {
   "cell_type": "markdown",
   "id": "eb299f82-f4b1-4f85-9195-07724f6dd4cb",
   "metadata": {},
   "source": [
    "# Vector search with LangChain (Azure AI Search)\n",
    "이 노트북에서는 LangChain을 통해 Azure AI Search의 검색 기능들을 사용해 볼 것이다.\n",
    "\n",
    "- 키워드 검색\n",
    "- 벡터 검색\n",
    "- 하이브리드 검색\n",
    "- 의미 체계 하이브리드 검색\n",
    "\n"
   ]
  },
  {
   "cell_type": "markdown",
   "id": "38c68a5b",
   "metadata": {},
   "source": [
    "# 사전 준비\n",
    "이 파이썬 예제를 실행하려면 다음과 같은 환경이 필요하다:\n",
    "- Azure AI Search 리소스의 엔드포인트 및 쿼리 API 키\n",
    "- Azure OpenAI Service를 사용할 수 있는 [승인 완료](https://aka.ms/oai/access)된 Azure 구독\n",
    "- Azure OpenAI Service에 배포된 `text-embedding-ada-002` Embeddings 모델. 이 모델의 API 버전은 `2024-02-01`을 사용했다. 배포 이름은 모델 이름과 동일하게 `text-embedding-ada-002`로 명명했다.\n",
    "- Azure OpenAI Service 연동 및 모델 정보\n",
    "  - OpenAI API 키\n",
    "  - OpenAI Embeddings 모델의 배포 이름\n",
    "  - OpenAI API 버전\n",
    "- Python (이 예제는 버전 3.12.4로 테스트 했다.)\n",
    "\n",
    "이 예제에서는 Visual Studio Code와 [Jupyter extension](https://marketplace.visualstudio.com/items?itemName=ms-toolsai.jupyter)를 사용한다."
   ]
  },
  {
   "cell_type": "markdown",
   "id": "1e7c8bef",
   "metadata": {},
   "source": [
    "## 패키지 설치"
   ]
  },
  {
   "cell_type": "code",
   "execution_count": null,
   "id": "d3ddc3ca",
   "metadata": {},
   "outputs": [],
   "source": [
    "!pip install azure-search-documents==11.4.0\n"
   ]
  },
  {
   "cell_type": "code",
   "execution_count": null,
   "id": "cdcfa726",
   "metadata": {},
   "outputs": [],
   "source": [
    "!pip install azure-identity==1.17.1"
   ]
  },
  {
   "cell_type": "code",
   "execution_count": null,
   "id": "10bea704",
   "metadata": {},
   "outputs": [],
   "source": [
    "!pip install openai==1.35.3\n",
    "!pip install langchain==0.2.5"
   ]
  },
  {
   "cell_type": "code",
   "execution_count": null,
   "id": "da1d9bbd-e2b9-451a-a872-56f19430d0e6",
   "metadata": {
    "scrolled": true
   },
   "outputs": [],
   "source": [
    "import azure.search.documents\n",
    "print(\"azure.search.documents\", azure.search.documents.__version__)\n",
    "import openai\n",
    "print(\"openai\", openai.__version__)\n",
    "import langchain\n",
    "print(\"langchain\", langchain.__version__)"
   ]
  },
  {
   "cell_type": "markdown",
   "id": "524420cf",
   "metadata": {},
   "source": [
    "## 라이브러리 및 환경변수 불러오기"
   ]
  },
  {
   "cell_type": "code",
   "execution_count": null,
   "id": "94c62e8d-9891-4fde-a989-9bb040e1558f",
   "metadata": {},
   "outputs": [],
   "source": [
    "import os\n",
    "\n",
    "os.environ[\"AZURESEARCH_FIELDS_CONTENT\"]=\"content\"\n",
    "os.environ[\"AZURESEARCH_FIELDS_CONTENT_VECTOR\"]=\"embedding\"\n",
    "\n",
    "from langchain_openai import AzureOpenAIEmbeddings\n",
    "from langchain_community.vectorstores.azuresearch import AzureSearch"
   ]
  },
  {
   "cell_type": "markdown",
   "id": "8c014e02",
   "metadata": {},
   "source": [
    "## 연동 설정"
   ]
  },
  {
   "cell_type": "code",
   "execution_count": null,
   "id": "652d5c38-7c3d-4849-8079-6f4bcc144a2b",
   "metadata": {},
   "outputs": [],
   "source": [
    "# AI Search\n",
    "service_endpoint: str = \"<Your search service endpoint>\"\n",
    "service_admin_key: str = \"<Your search service admin key>\"\n",
    "\n",
    "os.environ[\"AZURE_OPENAI_API_KEY\"] = \"Your OpenAI API Key\"\n",
    "os.environ[\"AZURE_OPENAI_ENDPOINT\"] = \"https://<Your OpenAI Service>.openai.azure.com/\"\n",
    "\n",
    "model: str = \"text-embedding-ada-002\"\n",
    "index_name: str = \"gptkbindex\" # 00_DataIngest_AzureAISearch_PythonSDK.ipynb 에서 생성한 인덱스 이름"
   ]
  },
  {
   "cell_type": "code",
   "execution_count": null,
   "id": "59d75f51",
   "metadata": {},
   "outputs": [],
   "source": [
    "embeddings = AzureOpenAIEmbeddings(\n",
    "    azure_deployment=model,\n",
    "    openai_api_version=\"2024-02-01\"\n",
    ")\n",
    "\n",
    "vector_store: AzureSearch = AzureSearch(\n",
    "    azure_search_endpoint=service_endpoint,\n",
    "    azure_search_key=service_admin_key,\n",
    "    index_name=index_name,\n",
    "    embedding_function=embeddings.embed_query,\n",
    "    semantic_configuration_name=\"default\"\n",
    ")"
   ]
  },
  {
   "cell_type": "markdown",
   "id": "1e85da5c-77b3-45b2-9dd4-e5dd128ccb41",
   "metadata": {},
   "source": [
    "# 1. 키워드 검색\n",
    "가장 간단한 검색인 키워드 검색부터 살펴보자. `ko.lucene`이라는 표준 한국어 분석기에 탑재된 사전 기반 토크나이저를 사용해서 토큰으로 분할한다. 분할된 토큰으로 역인덱스(역색인)를 생성한다.\n",
    "\n",
    "그리고 TF/IDF 기반의 [BM25](https://en.wikipedia.org/wiki/Okapi_BM25) 채점 알고리즘을 사용해서 문장 내 토큰의 일치빈도를 보며 연관성 점수를 계산한다. 내부적으로는 토큰의 희소성과 문장의 밀도 등에도 가중치를 부여한다. 키워드 검색에서는 오타가 생기면 가령 아래의 예제처럼 **몽골**의 오타인 '몽돌'로 검색하면 기대한 결과가 나타나지 않거나 더 적게 나타날 수 있다."
   ]
  },
  {
   "cell_type": "code",
   "execution_count": null,
   "id": "ec703c22-5016-494f-b548-1996f279fe86",
   "metadata": {
    "scrolled": true
   },
   "outputs": [],
   "source": [
    "from langchain_community.retrievers import AzureAISearchRetriever\n",
    "\n",
    "query = \"몽돌 전쟁을 대비하기 위해 어떤 준비를 했나요?\"\n",
    "retriever = AzureAISearchRetriever(\n",
    "    service_name=\"gptkb-xxxxxxxxx\", #Your Azure AI Search service name\n",
    "    index_name=index_name,\n",
    "    api_key=service_admin_key,\n",
    "    content_key=\"content\",\n",
    "    top_k=3,\n",
    ")\n",
    "\n",
    "docs = retriever.invoke(query)\n",
    "for doc in docs:\n",
    "    print(f\"Source:{doc.metadata[\"sourcepage\"]}\")\n",
    "    print(f\"Score:{doc.metadata[\"@search.score\"]}\")\n",
    "    print(f\"Content: {doc.page_content}\")\n",
    "    "
   ]
  },
  {
   "cell_type": "markdown",
   "id": "0cda9f83-1e4d-437f-82e3-515258dcce9d",
   "metadata": {},
   "source": [
    "# 2. 벡터 유사도 검색"
   ]
  },
  {
   "cell_type": "markdown",
   "id": "38d47ed0-380f-4ccd-a7c4-9d4e08569a06",
   "metadata": {},
   "source": [
    "# 2.1. 간단한 벡터 검색\n",
    "'몽**돌** 전쟁을 대비하기 위해 어떤 준비를 했나요?'라고 일부러 철자를 틀리게 입력한 쿼리로 검색을 해보자.\n",
    "`text-embeddings-ada-002`로 생성한 벡터를 검색하면 일치하는 키워드를 찾는데 얽매이지 않고 문장의 유사도만을 고려해서 검색한다. 오타도 적절하게 무시하면서 검색하기 때문에 키워드 검색보다 더 나은 결과를 보여준다."
   ]
  },
  {
   "cell_type": "code",
   "execution_count": null,
   "id": "92f3092d-ced3-4c3e-b3ad-59c7d045585c",
   "metadata": {},
   "outputs": [],
   "source": [
    "query = \"몽돌 전쟁을 대비하기 위해 어떤 준비를 했나요?\"  \n",
    "\n",
    "docs = vector_store.vector_search_with_score(\n",
    "    query=query,\n",
    "    k=3\n",
    ")\n",
    "\n",
    "for doc in docs:\n",
    "    content = docs[0][0]\n",
    "    score = docs[0][1]\n",
    "    print(f\"Source:{content.metadata[\"sourcepage\"]}\")\n",
    "    print(f\"Score:{score}\")\n",
    "    print(f\"Content: {content.page_content}\")"
   ]
  },
  {
   "cell_type": "markdown",
   "id": "ab2500ed-c144-48ba-adf3-a1108f7af3f7",
   "metadata": {},
   "source": [
    "## 2.1.1. 다국어 처리\n",
    "`text-embeddings-ada-002`의 다국어 처리 능력을 확인하기 위해 한국어 문서를 영어로 검색해보자."
   ]
  },
  {
   "cell_type": "code",
   "execution_count": null,
   "id": "fc224552-6d61-4824-8cd8-6dd22b2cc6ab",
   "metadata": {
    "scrolled": true
   },
   "outputs": [],
   "source": [
    "query = \"What preparations were made to prepare for the Mongol invasion?\"  \n",
    "\n",
    "docs = vector_store.vector_search_with_score(\n",
    "    query=query,\n",
    "    k=3\n",
    ")\n",
    "\n",
    "for doc in docs:\n",
    "    content = docs[0][0]\n",
    "    score = docs[0][1]\n",
    "    print(f\"Source:{content.metadata[\"sourcepage\"]}\")\n",
    "    print(f\"Score:{score}\")\n",
    "    print(f\"Content: {content.page_content}\")"
   ]
  },
  {
   "cell_type": "markdown",
   "id": "4e0c43f9-ec15-41a7-bd36-244be63145cb",
   "metadata": {},
   "source": [
    "# 2.2. 하이브리드 검색\n",
    "하이브리드 검색은 키워드 검색과 벡터 검색 모두를 쿼리에 사용한다. 키워드 검색 스코어를 구할 떄는 Okapi BM25 알고리즘을 사용해서 스코어를 계산하고, 벡터 검색에는 코사인 유사도를 기준으로 스코어를 계산한다. 이 서로 다른 계산 결과를 융합하는 방법으로는 [Reciprocal Rank Fusion(RRF)](https://learn.microsoft.com/azure/search/hybrid-search-ranking)을 사용한다. RRF는 두 방식으로 계산한 문서 랭크의 역수의 합을 구해서 문서 순위를 기준으로 어느 쪽의 랭크라도 상위에 있는 쪽이 스코어가 높아지는 구조다."
   ]
  },
  {
   "cell_type": "code",
   "execution_count": null,
   "id": "2318cff5-7c4d-45d2-9252-3fac51e5eaa7",
   "metadata": {
    "scrolled": true
   },
   "outputs": [],
   "source": [
    "query = \"최씨정권을 타도하고 최고 권력자가 된 인물은?\"  \n",
    "# Perform a hybrid search\n",
    "docs = vector_store.similarity_search(\n",
    "    query=query,\n",
    "    k=5,\n",
    "    search_type=\"hybrid\",\n",
    ")\n",
    "\n",
    "for doc in docs:\n",
    "    print(f\"Source:{doc.metadata[\"sourcepage\"]}\")\n",
    "    print(f\"Content: {doc.page_content}\")"
   ]
  },
  {
   "cell_type": "code",
   "execution_count": null,
   "id": "973ce3a2",
   "metadata": {},
   "outputs": [],
   "source": [
    "query = \"최씨정권을 타도하고 최고 권력자가 된 인물은?\"  \n",
    "# similarity_search에 search_type=\"hybrid\"를 지정하는 것과 동일하다.\n",
    "docs = vector_store.hybrid_search(\n",
    "    query=query,\n",
    "    k=5\n",
    ")\n",
    "\n",
    "for doc in docs:\n",
    "    print(f\"Source:{doc.metadata[\"sourcepage\"]}\")\n",
    "    print(f\"Content: {doc.page_content}\")"
   ]
  },
  {
   "cell_type": "markdown",
   "id": "293733e4",
   "metadata": {},
   "source": [
    "# 2.3 의미 체계 하이브리드 검색\n",
    "의미 체계 하이브리드 검색(하이브리드 검색 + 의미 체계 순위 지정)은 Azure AI Search에서만 지원하는 검색 기능으로, 하이브리드 검색과 검색 결과를 정확도가 높은 순서로 정렬하는 순위 재책정 기능(의미 체계 순위 지정)을 조합한 고도화된 검색 방법이다. 순위 재책정에는 마이크로소프트가 만든 언어 모델인 [Turing](https://techcommunity.microsoft.com/t5/ai-azure-ai-services-blog/introducing-multilingual-support-for-semantic-search-on-azure/ba-p/2385110) 모델을 사용한다."
   ]
  },
  {
   "cell_type": "code",
   "execution_count": null,
   "id": "2e5c78ca",
   "metadata": {
    "scrolled": true
   },
   "outputs": [],
   "source": [
    "query = \"무신정변을 일으켜 무신정권을 수립한 무신 3명은?\"  \n",
    "\n",
    "docs = vector_store.semantic_hybrid_search_with_score(\n",
    "    query=query,\n",
    "    k=5\n",
    ")\n",
    "\n",
    "for doc in docs:\n",
    "    content = docs[0][0]\n",
    "    score = docs[0][1]\n",
    "    print(f\"Source:{content.metadata[\"sourcepage\"]}\")\n",
    "    print(f\"Score:{score}\")\n",
    "    print(f\"Content: {content.page_content}\")"
   ]
  }
 ],
 "metadata": {
  "kernelspec": {
   "display_name": "Python 3 (ipykernel)",
   "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.4"
  }
 },
 "nbformat": 4,
 "nbformat_minor": 5
}