embedchain

1
{
2
  "cells": [
3
    {
4
      "cell_type": "markdown",
5
      "metadata": {
6
        "id": "b02n_zJ_hl3d"
7
      },
8
      "source": [
9
        "## Cookbook for using OpenSearchDB with Embedchain"
10
      ]
11
    },
12
    {
13
      "cell_type": "markdown",
14
      "metadata": {
15
        "id": "gyJ6ui2vhtMY"
16
      },
17
      "source": [
18
        "### Step-1: Install embedchain package"
19
      ]
20
    },
21
    {
22
      "cell_type": "code",
23
      "execution_count": null,
24
      "metadata": {
25
        "id": "-NbXjAdlh0vJ"
26
      },
27
      "outputs": [],
28
      "source": [
29
        "!pip install embedchain[opensearch]"
30
      ]
31
    },
32
    {
33
      "cell_type": "markdown",
34
      "metadata": {
35
        "id": "nGnpSYAAh2bQ"
36
      },
37
      "source": [
38
        "### Step-2: Set OpenAI environment variables and install the dependencies.\n",
39
        "\n",
40
        "You can find this env variable on your [OpenAI dashboard](https://platform.openai.com/account/api-keys). Now lets install the dependencies needed for Opensearch."
41
      ]
42
    },
43
    {
44
      "cell_type": "code",
45
      "execution_count": null,
46
      "metadata": {
47
        "id": "0fBdQ9GAiRvK"
48
      },
49
      "outputs": [],
50
      "source": [
51
        "import os\n",
52
        "from embedchain import App\n",
53
        "\n",
54
        "os.environ[\"OPENAI_API_KEY\"] = \"sk-xxx\""
55
      ]
56
    },
57
    {
58
      "cell_type": "markdown",
59
      "metadata": {
60
        "id": "PGt6uPLIi1CS"
61
      },
62
      "source": [
63
        "### Step-3 Create embedchain app and define your config"
64
      ]
65
    },
66
    {
67
      "cell_type": "code",
68
      "execution_count": null,
69
      "metadata": {
70
        "id": "Amzxk3m-i3tD"
71
      },
72
      "outputs": [],
73
      "source": [
74
        "app = App.from_config(config={\n",
75
        "    \"provider\": \"opensearch\",\n",
76
        "    \"config\": {\n",
77
        "        \"opensearch_url\": \"your-opensearch-url.com\",\n",
78
        "        \"http_auth\": [\"admin\", \"admin\"],\n",
79
        "        \"vector_dimension\": 1536,\n",
80
        "        \"collection_name\": \"my-app\",\n",
81
        "        \"use_ssl\": False,\n",
82
        "        \"verify_certs\": False\n",
83
        "    }\n",
84
        "})"
85
      ]
86
    },
87
    {
88
      "cell_type": "markdown",
89
      "metadata": {
90
        "id": "XNXv4yZwi7ef"
91
      },
92
      "source": [
93
        "### Step-4: Add data sources to your app"
94
      ]
95
    },
96
    {
97
      "cell_type": "code",
98
      "execution_count": null,
99
      "metadata": {
100
        "id": "Sn_0rx9QjIY9"
101
      },
102
      "outputs": [],
103
      "source": [
104
        "app.add(\"https://www.forbes.com/profile/elon-musk\")"
105
      ]
106
    },
107
    {
108
      "cell_type": "markdown",
109
      "metadata": {
110
        "id": "_7W6fDeAjMAP"
111
      },
112
      "source": [
113
        "### Step-5: All set. Now start asking questions related to your data"
114
      ]
115
    },
116
    {
117
      "cell_type": "code",
118
      "execution_count": null,
119
      "metadata": {
120
        "id": "cvIK7dWRjN_f"
121
      },
122
      "outputs": [],
123
      "source": [
124
        "while(True):\n",
125
        "    question = input(\"Enter question: \")\n",
126
        "    if question in ['q', 'exit', 'quit']:\n",
127
        "        break\n",
128
        "    answer = app.query(question)\n",
129
        "    print(answer)"
130
      ]
131
    }
132
  ],
133
  "metadata": {
134
    "colab": {
135
      "provenance": []
136
    },
137
    "kernelspec": {
138
      "display_name": "Python 3",
139
      "name": "python3"
140
    },
141
    "language_info": {
142
      "name": "python"
143
    }
144
  },
145
  "nbformat": 4,
146
  "nbformat_minor": 0
147
}
148