mirror of
https://github.com/ItzCrazyKns/Perplexica.git
synced 2026-03-13 16:16:46 +00:00
feat(app): rename to 'vane'
This commit is contained in:
ItzCrazyKns
@@ -1,8 +1,8 @@
|
||||
# Perplexica Search API Documentation
|
||||
# Vane Search API Documentation
|
||||
|
||||
## Overview
|
||||
|
||||
Perplexica’s Search API makes it easy to use our AI-powered search engine. You can run different types of searches, pick the models you want to use, and get the most recent info. Follow the following headings to learn more about Perplexica's search API.
|
||||
Vane's Search API makes it easy to use our AI-powered search engine. You can run different types of searches, pick the models you want to use, and get the most recent info. Follow the following headings to learn more about Vane's search API.
|
||||
|
||||
## Endpoints
|
||||
|
||||
@@ -53,7 +53,7 @@ Use the `id` field as the `providerId` and the `key` field from the models array
|
||||
|
||||
**Full URL**: `http://localhost:3000/api/search`
|
||||
|
||||
**Note**: Replace `localhost:3000` with your Perplexica instance URL if running on a different host or port
|
||||
**Note**: Replace `localhost:3000` with your Vane instance URL if running on a different host or port
|
||||
|
||||
### Request
|
||||
|
||||
@@ -73,12 +73,12 @@ The API accepts a JSON object in the request body, where you define the enabled
|
||||
},
|
||||
"optimizationMode": "speed",
|
||||
"sources": ["web"],
|
||||
"query": "What is Perplexica",
|
||||
"query": "What is Vane",
|
||||
"history": [
|
||||
["human", "Hi, how are you?"],
|
||||
["assistant", "I am doing well, how can I help you today?"]
|
||||
],
|
||||
"systemInstructions": "Focus on providing technical details about Perplexica's architecture.",
|
||||
"systemInstructions": "Focus on providing technical details about Vane's architecture.",
|
||||
"stream": false
|
||||
}
|
||||
```
|
||||
@@ -115,8 +115,8 @@ The API accepts a JSON object in the request body, where you define the enabled
|
||||
|
||||
```json
|
||||
[
|
||||
["human", "What is Perplexica?"],
|
||||
["assistant", "Perplexica is an AI-powered search engine..."]
|
||||
["human", "What is Vane?"],
|
||||
["assistant", "Vane is an AI-powered search engine..."]
|
||||
]
|
||||
```
|
||||
|
||||
@@ -130,20 +130,20 @@ The response from the API includes both the final message and the sources used t
|
||||
|
||||
```json
|
||||
{
|
||||
"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].",
|
||||
"message": "Vane 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 Vane:\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, Vane offers flexibility and transparency, allowing users to explore its functionalities without the constraints of proprietary software [3][10].",
|
||||
"sources": [
|
||||
{
|
||||
"content": "Perplexica is an innovative, open-source AI-powered search engine designed to enhance the way users search for information online.",
|
||||
"content": "Vane is an innovative, open-source AI-powered search engine designed to enhance the way users search for information online.",
|
||||
"metadata": {
|
||||
"title": "What is Perplexica, and how does it function as an AI-powered search ...",
|
||||
"url": "https://askai.glarity.app/search/What-is-Perplexica--and-how-does-it-function-as-an-AI-powered-search-engine"
|
||||
"title": "What is Vane, and how does it function as an AI-powered search ...",
|
||||
"url": "https://askai.glarity.app/search/What-is-Vane--and-how-does-it-function-as-an-AI-powered-search-engine"
|
||||
}
|
||||
},
|
||||
{
|
||||
"content": "Perplexica is an open-source AI-powered search tool that dives deep into the internet to find precise answers.",
|
||||
"content": "Vane is an open-source AI-powered search tool that dives deep into the internet to find precise answers.",
|
||||
"metadata": {
|
||||
"title": "Sahar Mor's Post",
|
||||
"url": "https://www.linkedin.com/posts/sahar-mor_a-new-open-source-project-called-perplexica-activity-7204489745668694016-ncja"
|
||||
"url": "https://www.linkedin.com/posts/sahar-mor_a-new-open-source-project-called-vane-activity-7204489745668694016-ncja"
|
||||
}
|
||||
}
|
||||
....
|
||||
@@ -160,7 +160,7 @@ Example of streamed response objects:
|
||||
```
|
||||
{"type":"init","data":"Stream connected"}
|
||||
{"type":"sources","data":[{"content":"...","metadata":{"title":"...","url":"..."}},...]}
|
||||
{"type":"response","data":"Perplexica is an "}
|
||||
{"type":"response","data":"Vane is an "}
|
||||
{"type":"response","data":"innovative, open-source "}
|
||||
{"type":"response","data":"AI-powered search engine..."}
|
||||
{"type":"done"}
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
# Perplexica Architecture
|
||||
# Vane Architecture
|
||||
|
||||
Perplexica is a Next.js application that combines an AI chat experience with search.
|
||||
Vane is a Next.js application that combines an AI chat experience with search.
|
||||
|
||||
For a high level flow, see [WORKING.md](WORKING.md). For deeper implementation details, see [CONTRIBUTING.md](../../CONTRIBUTING.md).
|
||||
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
# How Perplexica Works
|
||||
# How Vane Works
|
||||
|
||||
This is a high level overview of how Perplexica answers a question.
|
||||
This is a high level overview of how Vane answers a question.
|
||||
|
||||
If you want a component level overview, see [README.md](README.md).
|
||||
|
||||
@@ -58,7 +58,7 @@ We prompt the model to cite the references it used. The UI then renders those ci
|
||||
|
||||
## Search API
|
||||
|
||||
If you are integrating Perplexica into another product, you can call `POST /api/search`.
|
||||
If you are integrating Vane into another product, you can call `POST /api/search`.
|
||||
|
||||
It returns:
|
||||
|
||||
|
||||
@@ -1,60 +1,60 @@
|
||||
# Update Perplexica to the latest version
|
||||
# Update Vane to the latest version
|
||||
|
||||
To update Perplexica to the latest version, follow these steps:
|
||||
To update Vane to the latest version, follow these steps:
|
||||
|
||||
## For Docker users (Using pre-built images)
|
||||
|
||||
Simply pull the latest image and restart your container:
|
||||
|
||||
```bash
|
||||
docker pull itzcrazykns1337/perplexica:latest
|
||||
docker stop perplexica
|
||||
docker rm perplexica
|
||||
docker run -d -p 3000:3000 -v perplexica-data:/home/perplexica/data --name perplexica itzcrazykns1337/perplexica:latest
|
||||
docker pull itzcrazykns1337/vane:latest
|
||||
docker stop vane
|
||||
docker rm vane
|
||||
docker run -d -p 3000:3000 -v vane-data:/home/vane/data --name vane itzcrazykns1337/vane:latest
|
||||
```
|
||||
|
||||
For slim version:
|
||||
|
||||
```bash
|
||||
docker pull itzcrazykns1337/perplexica:slim-latest
|
||||
docker stop perplexica
|
||||
docker rm perplexica
|
||||
docker run -d -p 3000:3000 -e SEARXNG_API_URL=http://your-searxng-url:8080 -v perplexica-data:/home/perplexica/data --name perplexica itzcrazykns1337/perplexica:slim-latest
|
||||
docker pull itzcrazykns1337/vane:slim-latest
|
||||
docker stop vane
|
||||
docker rm vane
|
||||
docker run -d -p 3000:3000 -e SEARXNG_API_URL=http://your-searxng-url:8080 -v vane-data:/home/vane/data --name vane itzcrazykns1337/vane:slim-latest
|
||||
```
|
||||
|
||||
Once updated, go to http://localhost:3000 and verify the latest changes. Your settings are preserved automatically.
|
||||
|
||||
## For Docker users (Building from source)
|
||||
|
||||
1. Navigate to your Perplexica directory and pull the latest changes:
|
||||
1. Navigate to your Vane directory and pull the latest changes:
|
||||
|
||||
```bash
|
||||
cd Perplexica
|
||||
cd Vane
|
||||
git pull origin master
|
||||
```
|
||||
|
||||
2. Rebuild the Docker image:
|
||||
|
||||
```bash
|
||||
docker build -t perplexica .
|
||||
docker build -t vane .
|
||||
```
|
||||
|
||||
3. Stop and remove the old container, then start the new one:
|
||||
|
||||
```bash
|
||||
docker stop perplexica
|
||||
docker rm perplexica
|
||||
docker run -p 3000:3000 -p 8080:8080 --name perplexica perplexica
|
||||
docker stop vane
|
||||
docker rm vane
|
||||
docker run -p 3000:3000 -p 8080:8080 --name vane vane
|
||||
```
|
||||
|
||||
4. Once the command completes, go to http://localhost:3000 and verify the latest changes.
|
||||
|
||||
## For non-Docker users
|
||||
|
||||
1. Navigate to your Perplexica directory and pull the latest changes:
|
||||
1. Navigate to your Vane directory and pull the latest changes:
|
||||
|
||||
```bash
|
||||
cd Perplexica
|
||||
cd Vane
|
||||
git pull origin master
|
||||
```
|
||||
|
||||
|
||||
Reference in New Issue
Block a user