Skip to content

Commit d79d854

Browse files
ItzCrazyKnsItzCrazyKns
committed
2 parents 8cb74f1 + f889127 commit d79d854

File tree

5 files changed

+78
-78
lines changed

5 files changed

+78
-78
lines changed

‎docs/API/SEARCH.md

Lines changed: 17 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -79,24 +79,24 @@ The response from the API includes both the final message and the sources used t
7979

8080
```json
8181
{
82-
"message": "Perplexica is an innovative, open-source AI-powered search engine designed to enhance the way users search for information online. Here are some key features and characteristics of Perplexica:\n\n- **AI-Powered Technology**: It utilizes advanced machine learning algorithms to not only retrieve information but also to understand the context and intent behind user queries, providing more relevant results [1][5].\n\n- **Open-Source**: Being open-source, Perplexica offers flexibility and transparency, allowing users to explore its functionalities without the constraints of proprietary software [3][10].",
83-
"sources": [
84-
{
85-
"pageContent": "Perplexica is an innovative, open-source AI-powered search engine designed to enhance the way users search for information online.",
86-
"metadata": {
87-
"title": "What is Perplexica, and how does it function as an AI-powered search ...",
88-
"url": "https://askai.glarity.app/search/What-is-Perplexica--and-how-does-it-function-as-an-AI-powered-search-engine"
89-
}
90-
},
91-
{
92-
"pageContent": "Perplexica is an open-source AI-powered search tool that dives deep into the internet to find precise answers.",
93-
"metadata": {
94-
"title": "Sahar Mor's Post",
95-
"url": "https://www.linkedin.com/posts/sahar-mor_a-new-open-source-project-called-perplexica-activity-7204489745668694016-ncja"
96-
}
97-
}
82+
"message": "Perplexica is an innovative, open-source AI-powered search engine designed to enhance the way users search for information online. Here are some key features and characteristics of Perplexica:\n\n- **AI-Powered Technology**: It utilizes advanced machine learning algorithms to not only retrieve information but also to understand the context and intent behind user queries, providing more relevant results [1][5].\n\n- **Open-Source**: Being open-source, Perplexica offers flexibility and transparency, allowing users to explore its functionalities without the constraints of proprietary software [3][10].",
83+
"sources": [
84+
{
85+
"pageContent": "Perplexica is an innovative, open-source AI-powered search engine designed to enhance the way users search for information online.",
86+
"metadata": {
87+
"title": "What is Perplexica, and how does it function as an AI-powered search ...",
88+
"url": "https://askai.glarity.app/search/What-is-Perplexica--and-how-does-it-function-as-an-AI-powered-search-engine"
89+
}
90+
},
91+
{
92+
"pageContent": "Perplexica is an open-source AI-powered search tool that dives deep into the internet to find precise answers.",
93+
"metadata": {
94+
"title": "Sahar Mor's Post",
95+
"url": "https://www.linkedin.com/posts/sahar-mor_a-new-open-source-project-called-perplexica-activity-7204489745668694016-ncja"
96+
}
97+
}
9898
....
99-
]
99+
]
100100
}
101101
```
102102

‎docs/architecture/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
## Perplexica's Architecture
1+
# Perplexica's Architecture
22

33
Perplexica's architecture consists of the following key components:
44

‎docs/architecture/WORKING.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
## How does Perplexica work?
1+
# How does Perplexica work?
22

33
Curious about how Perplexica works? Don't worry, we'll cover it here. Before we begin, make sure you've read about the architecture of Perplexica to ensure you understand what it's made up of. Haven't read it? You can read it [here](https://github.com/ItzCrazyKns/Perplexica/tree/master/docs/architecture/README.md).
44

@@ -10,10 +10,10 @@ We'll understand how Perplexica works by taking an example of a scenario where a
1010
4. After the information is retrieved, it is based on keyword-based search. We then convert the information into embeddings and the query as well, then we perform a similarity search to find the most relevant sources to answer the query.
1111
5. After all this is done, the sources are passed to the response generator. This chain takes all the chat history, the query, and the sources. It generates a response that is streamed to the UI.
1212

13-
### How are the answers cited?
13+
## How are the answers cited?
1414

1515
The LLMs are prompted to do so. We've prompted them so well that they cite the answers themselves, and using some UI magic, we display it to the user.
1616

17-
### Image and Video Search
17+
## Image and Video Search
1818

1919
Image and video searches are conducted in a similar manner. A query is always generated first, then we search the web for images and videos that match the query. These results are then returned to the user.

‎docs/installation/NETWORKING.md

Lines changed: 45 additions & 45 deletions
Original file line numberDiff line numberDiff line change
@@ -10,100 +10,100 @@ This guide will show you how to make Perplexica available over a network. Follow
1010

1111
3. Stop and remove the existing Perplexica containers and images:
1212

13-
```
14-
docker compose down --rmi all
15-
```
13+
```bash
14+
docker compose down --rmi all
15+
```
1616

1717
4. Open the `docker-compose.yaml` file in a text editor like Notepad++
1818

1919
5. Replace `127.0.0.1` with the IP address of the server Perplexica is running on in these two lines:
2020

21-
```
22-
args:
23-
- NEXT_PUBLIC_API_URL=http://127.0.0.1:3001/api
24-
- NEXT_PUBLIC_WS_URL=ws://127.0.0.1:3001
25-
```
21+
```bash
22+
args:
23+
- NEXT_PUBLIC_API_URL=http://127.0.0.1:3001/api
24+
- NEXT_PUBLIC_WS_URL=ws://127.0.0.1:3001
25+
```
2626

2727
6. Save and close the `docker-compose.yaml` file
2828

2929
7. Rebuild and restart the Perplexica container:
3030

31-
```
32-
docker compose up -d --build
33-
```
31+
```bash
32+
docker compose up -d --build
33+
```
3434

3535
## macOS
3636

3737
1. Open the Terminal application
3838

3939
2. Navigate to the directory with the `docker-compose.yaml` file:
4040

41-
```
42-
cd /path/to/docker-compose.yaml
43-
```
41+
```bash
42+
cd /path/to/docker-compose.yaml
43+
```
4444

4545
3. Stop and remove existing containers and images:
4646

47-
```
48-
docker compose down --rmi all
49-
```
47+
```bash
48+
docker compose down --rmi all
49+
```
5050

5151
4. Open `docker-compose.yaml` in a text editor like Sublime Text:
5252

53-
```
54-
nano docker-compose.yaml
55-
```
53+
```bash
54+
nano docker-compose.yaml
55+
```
5656

5757
5. Replace `127.0.0.1` with the server IP in these lines:
5858

59-
```
60-
args:
61-
- NEXT_PUBLIC_API_URL=http://127.0.0.1:3001/api
62-
- NEXT_PUBLIC_WS_URL=ws://127.0.0.1:3001
63-
```
59+
```bash
60+
args:
61+
- NEXT_PUBLIC_API_URL=http://127.0.0.1:3001/api
62+
- NEXT_PUBLIC_WS_URL=ws://127.0.0.1:3001
63+
```
6464

6565
6. Save and exit the editor
6666

6767
7. Rebuild and restart Perplexica:
6868

69-
```
70-
docker compose up -d --build
71-
```
69+
```bash
70+
docker compose up -d --build
71+
```
7272

7373
## Linux
7474

7575
1. Open the terminal
7676

7777
2. Navigate to the `docker-compose.yaml` directory:
7878

79-
```
80-
cd /path/to/docker-compose.yaml
81-
```
79+
```bash
80+
cd /path/to/docker-compose.yaml
81+
```
8282

8383
3. Stop and remove containers and images:
8484

85-
```
86-
docker compose down --rmi all
87-
```
85+
```bash
86+
docker compose down --rmi all
87+
```
8888

8989
4. Edit `docker-compose.yaml`:
9090

91-
```
92-
nano docker-compose.yaml
93-
```
91+
```bash
92+
nano docker-compose.yaml
93+
```
9494

9595
5. Replace `127.0.0.1` with the server IP:
9696

97-
```
98-
args:
99-
- NEXT_PUBLIC_API_URL=http://127.0.0.1:3001/api
100-
- NEXT_PUBLIC_WS_URL=ws://127.0.0.1:3001
101-
```
97+
```bash
98+
args:
99+
- NEXT_PUBLIC_API_URL=http://127.0.0.1:3001/api
100+
- NEXT_PUBLIC_WS_URL=ws://127.0.0.1:3001
101+
```
102102

103103
6. Save and exit the editor
104104

105105
7. Rebuild and restart Perplexica:
106106

107-
```
108-
docker compose up -d --build
109-
```
107+
```bash
108+
docker compose up -d --build
109+
```

‎docs/installation/UPDATING.md

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -6,33 +6,33 @@ To update Perplexica to the latest version, follow these steps:
66

77
1. Clone the latest version of Perplexica from GitHub:
88

9-
```bash
10-
git clone https://github.com/ItzCrazyKns/Perplexica.git
11-
```
9+
```bash
10+
git clone https://github.com/ItzCrazyKns/Perplexica.git
11+
```
1212

1313
2. Navigate to the Project Directory.
1414

1515
3. Pull latest images from registry.
1616

17-
```bash
18-
docker compose pull
19-
```
17+
```bash
18+
docker compose pull
19+
```
2020

2121
4. Update and Recreate containers.
2222

23-
```bash
24-
docker compose up -d
25-
```
23+
```bash
24+
docker compose up -d
25+
```
2626

2727
5. Once the command completes running go to http://localhost:3000 and verify the latest changes.
2828

2929
## For non Docker users
3030

3131
1. Clone the latest version of Perplexica from GitHub:
3232

33-
```bash
34-
git clone https://github.com/ItzCrazyKns/Perplexica.git
35-
```
33+
```bash
34+
git clone https://github.com/ItzCrazyKns/Perplexica.git
35+
```
3636

3737
2. Navigate to the Project Directory
3838
3. Execute `npm i` in both the `ui` folder and the root directory.

0 commit comments

Comments
 (0)