github/node-DeepResearch
1
0
Fork 0
mirror of https://github.com/jina-ai/node-DeepResearch.git synced 2026-03-22 07:29:35 +08:00
Code Issues Packages Projects Releases Wiki Activity

Update README.md

Browse Source
This commit is contained in:
Han Xiao
2025-02-09 16:21:52 +08:00
committed by GitHub
parent 3deee87c5a
commit ff34db5706
1 changed files with 6 additions and 19 deletions
Download Patch File Download Diff File Expand all files Collapse all files

25
README.md
View File

@@ -105,9 +105,7 @@ export DEFAULT_MODEL_NAME=qwen2.5-7b # your local llm model name
``` ```
## Server API ## OpenAI-Compatible Server API
### OpenAI-Compatible Chat Completions
Start the server: Start the server:
```bash ```bash
@@ -120,7 +118,7 @@ npm run serve --secret=your_secret_token
The server will start on http://localhost:3000 with the following endpoint: The server will start on http://localhost:3000 with the following endpoint:
#### POST /v1/chat/completions ### POST /v1/chat/completions
```bash ```bash
# Without authentication # Without authentication
curl http://localhost:3000/v1/chat/completions \ curl http://localhost:3000/v1/chat/completions \
@@ -208,33 +206,22 @@ Note: The think content in streaming responses is wrapped in XML tags:
[final answer] [final answer]
``` ```
## Server Setup
### Local Setup ## Docker Setup
Start the server:
```bash
# Without authentication
npm run serve
# With authentication (clients must provide this secret as Bearer token) ### Build Docker Image
npm run serve --secret=your_secret_token
```
### Docker Setup
#### Build Docker Image
To build the Docker image for the application, run the following command: To build the Docker image for the application, run the following command:
```bash ```bash
docker build -t deepresearch:latest . docker build -t deepresearch:latest .
``` ```
#### Run Docker Container ### Run Docker Container
To run the Docker container, use the following command: To run the Docker container, use the following command:
```bash ```bash
docker run -p 3000:3000 --env GEMINI_API_KEY=your_gemini_api_key --env JINA_API_KEY=your_jina_api_key deepresearch:latest docker run -p 3000:3000 --env GEMINI_API_KEY=your_gemini_api_key --env JINA_API_KEY=your_jina_api_key deepresearch:latest
``` ```
#### Docker Compose ### Docker Compose
You can also use Docker Compose to manage multi-container applications. To start the application with Docker Compose, run: You can also use Docker Compose to manage multi-container applications. To start the application with Docker Compose, run:
```bash ```bash
docker-compose up docker-compose up