Skip to content

Commit 6f0a2c9

Browse files
buggyhunterbuggyhunter
committed
DX-1894: search docs init
1 parent 98c314c commit 6f0a2c9

19 files changed

+220
-0
lines changed

‎mint.json

Lines changed: 74 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -57,6 +57,10 @@
5757
"name": "Workflow",
5858
"url": "workflow"
5959
},
60+
{
61+
"name": "Search",
62+
"url": "search"
63+
},
6064
{
6165
"name": "Developer API",
6266
"url": "devops"
@@ -1377,6 +1381,76 @@
13771381
"workflow/roadmap",
13781382
"workflow/llms-txt"
13791383
]
1384+
},
1385+
{
1386+
"group": "",
1387+
"pages": [
1388+
{
1389+
"group": "Overall",
1390+
"pages": [
1391+
"search/overall/getstarted",
1392+
"search/overall/whatissearch",
1393+
"search/overall/compare",
1394+
"search/overall/pricing",
1395+
"search/overall/llms-txt"
1396+
]
1397+
},
1398+
{
1399+
"group": "Features",
1400+
"pages": [
1401+
"search/features/algorithm"
1402+
]
1403+
},
1404+
{
1405+
"group": "REST API",
1406+
"pages": [
1407+
"search/api/get-started"
1408+
]
1409+
},
1410+
{
1411+
"group": "SDKs",
1412+
"pages": [
1413+
{
1414+
"group": "Typescript",
1415+
"pages": [
1416+
"search/sdks/ts/getting-started",
1417+
"search/sdks/ts/contributing",
1418+
"search/sdks/ts/overview-backup"
1419+
]
1420+
},
1421+
{
1422+
"group": "Python",
1423+
"pages": [
1424+
"search/sdks/py/gettingstarted",
1425+
"search/sdks/py/features"
1426+
]
1427+
},
1428+
{
1429+
"group": "PHP",
1430+
"pages": [
1431+
"search/sdks/php/getting-started",
1432+
"search/sdks/php/laravel"
1433+
]
1434+
}
1435+
]
1436+
},
1437+
{
1438+
"group": "Integrations",
1439+
"pages": [
1440+
"search/integrations/ai-sdk"
1441+
]
1442+
},
1443+
{
1444+
"group": "Tutorials",
1445+
"pages": [
1446+
"search/tutorials/nextjs"
1447+
]
1448+
},
1449+
{
1450+
"group": "Help",
1451+
"pages": ["search/help/faq"]
1452+
}
1453+
]
13801454
}
13811455
],
13821456
"api": {

‎search/.keep

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
// This file ensures the search directory is tracked by version control.

‎search/api/get-started.mdx

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
// Placeholder for get-started.mdx in search tab

‎search/features/algorithm.mdx

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
// Placeholder for algorithm.mdx in search tab

‎search/help/faq.mdx

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
// Placeholder for faq.mdx in search tab

‎search/integrations/ai-sdk.mdx

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
// Placeholder for ai-sdk.mdx in search tab

‎search/overall/compare.mdx

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
---
2+
title: Compare
3+
---
4+
5+
// Placeholder for compare.mdx in search tab

‎search/overall/getstarted.mdx

Lines changed: 120 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,120 @@
1+
---
2+
title: Getting Started
3+
---
4+
5+
<Check >
6+
**Prerequisite**
7+
8+
You need an Upstash account before creating a search index, create one
9+
[here](https://console.upstash.com).
10+
11+
</Check>
12+
13+
## Create an Index
14+
15+
Once you logged in, you can create a Search Index by clicking on the `Create Index` button in the Search tab.
16+
17+
<Frame style={{width: '600px'}}>
18+
<img src="/img/search/getstarted/create_index.png" />
19+
</Frame>
20+
21+
**Name:** Type a name for your index.
22+
23+
**Region:** Choose the region for your index. For optimal performance, select the region closest to your applications. We plan to support additional regions and cloud providers. Feel free to send your requests to [support@upstash.com](mailto:support@upstash.com)
24+
25+
**Type:** The type of index: Dense, Sparse or Hybrid. For semantic search, you can prefer dense. For full text (or keyword) search, you can prefer sparse. If you need a combination, you can choose hybrid.
26+
27+
If you choose Dense or Hybrid as index type, you will also be presented with options to select the dimensions and distance metric of your index.
28+
29+
<Tip>
30+
For the purpose of using the code samples on this page, you can create a dense index with `dimension: 2`. Distance metric can be any of the options.
31+
</Tip>
32+
33+
Once you pick these options, you will choose a plan:
34+
35+
<Frame style={{width: '600px'}}>
36+
<img src="/img/search/getstarted/select_plan.png" />
37+
</Frame>
38+
39+
**Free:** The free plan is suitable for small projects. It has a limit of 10,000 queries and 10,000 updates daily.
40+
41+
**Pay as You Go:** Pay as you go plan is a flexible plan with per-request-pricing. It is suitable for projects with unpredictable traffic.
42+
43+
**Fixed:** Fixed plan is suitable for projects with predictable traffic. It has a fixed monthly price with 1M query and 1M updates daily.
44+
45+
**Pro:** Pro plan is suitable for projects with high traffic and storage needs. It has a fixed monthly price with extra security and isolation features.
46+
47+
**Enterprise:** If you plan to have over a billion records then Enterprise plan is for you. It has a fixed monthly price with extra security and isolation features. Contact us at [sales@upstash.com](mailto:sales@upstash.com) for more information.
48+
49+
## Insert Index
50+
51+
You can access data in your index using REST API or our SDKs. You can copy the sample code from the `Connect` section in the console.
52+
53+
<Tabs>
54+
55+
<Tab title="Python">
56+
```python
57+
# Placeholder for Python example
58+
```
59+
</Tab>
60+
61+
<Tab title="JavaScript">
62+
```ts
63+
// Placeholder for JavaScript example
64+
```
65+
</Tab>
66+
67+
<Tab title="Go">
68+
```go
69+
// Placeholder for Go example
70+
```
71+
</Tab>
72+
73+
<Tab title="PHP">
74+
```php
75+
// Placeholder for PHP example
76+
```
77+
</Tab>
78+
79+
<Tab title="curl">
80+
```shell
81+
# Placeholder for curl example
82+
```
83+
</Tab>
84+
85+
</Tabs>
86+
87+
## Query Index
88+
You can perform a search by providing a query as a parameter. The dimension of the query must match the dimension of your index. Also, you can query by metadata filtering.
89+
90+
<Note>
91+
Upstash is eventually consistent, so there may be a delay before the newly inserted or updated records are ready for querying.
92+
</Note>
93+
94+
<Tabs>
95+
96+
<Tab title="Python">
97+
```python
98+
# Placeholder for Python query example
99+
```
100+
</Tab>
101+
102+
<Tab title="JavaScript">
103+
```ts
104+
// Placeholder for JavaScript query example
105+
```
106+
</Tab>
107+
108+
<Tab title="Go">
109+
```go
110+
// Placeholder for Go query example
111+
```
112+
</Tab>
113+
114+
<Tab title="PHP">
115+
```php
116+
// Placeholder for PHP query example
117+
```
118+
</Tab>
119+
120+
</Tabs>

‎search/overall/llms-txt.mdx

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
// Placeholder for llms-txt.mdx in search tab

‎search/overall/pricing.mdx

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
// Placeholder for pricing.mdx in search tab

‎search/overall/whatissearch.mdx

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
---
2+
title: What is Search?
3+
description: Create an Upstash Redis database in seconds
4+
---
5+
6+
//TODO

‎search/sdks/php/getting-started.mdx

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
// Placeholder for getting-started.mdx in search tab

‎search/sdks/php/laravel.mdx

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
// Placeholder for laravel.mdx in search tab

‎search/sdks/py/features.mdx

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
// Placeholder for features.mdx in search tab

‎search/sdks/py/gettingstarted.mdx

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
// Placeholder for gettingstarted.mdx in search tab

‎search/sdks/ts/contributing.mdx

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
// Placeholder for contributing.mdx in search tab

‎search/sdks/ts/getting-started.mdx

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
// Placeholder for getting-started.mdx in search tab

‎search/sdks/ts/overview-backup.mdx

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
// Placeholder for overview-backup.mdx in search tab

‎search/tutorials/nextjs.mdx

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
// Placeholder for gradio-application.mdx in search tab

0 commit comments

Comments
 (0)