AAEE86 fa34b9aed6 Modify model parameters in Spark LLMs and zhipuai LLMs (#8078) пре 1 година
..
.idea 7ae728a9a3 fix nltk averaged_perceptron_tagger download and fix score limit is none (#7582) пре 1 година
.vscode 0d4753785f chore: remove .idea and .vscode from root path (#7437) пре 1 година
configs d542b15cc0 feat: support redis sentinel mode (#7756) пре 1 година
constants 2d7954c7da Fix variable typo (#8084) пре 1 година
contexts 3571292fbf chore(api): Introduce Ruff Formatter. (#7291) пре 1 година
controllers 2d7954c7da Fix variable typo (#8084) пре 1 година
core fa34b9aed6 Modify model parameters in Spark LLMs and zhipuai LLMs (#8078) пре 1 година
docker 8dfdb37de3 fix: use LOG_LEVEL for celery startup (#7628) пре 1 година
events 2d7954c7da Fix variable typo (#8084) пре 1 година
extensions d542b15cc0 feat: support redis sentinel mode (#7756) пре 1 година
fields 80aa7c4019 feat: allow users to use the app icon as the answer icon (#7888) пре 1 година
libs fbf31b5d52 feat: custom app icon (#7196) пре 1 година
migrations 80aa7c4019 feat: allow users to use the app icon as the answer icon (#7888) пре 1 година
models 2d7954c7da Fix variable typo (#8084) пре 1 година
schedule 3571292fbf chore(api): Introduce Ruff Formatter. (#7291) пре 1 година
services feefeb44d7 fix LangSmith project config error (#7996) пре 1 година
tasks 2d7954c7da Fix variable typo (#8084) пре 1 година
templates 00b4cc3cd4 feat: implement forgot password feature (#5534) пре 1 година
tests 2d7954c7da Fix variable typo (#8084) пре 1 година
.dockerignore 27f0ae8416 build: support Poetry for depencencies tool in api's Dockerfile (#5105) пре 1 година
.env.example 2060db8e11 fix: change milvus init args from (host, port) to (url, token) (#8019) пре 1 година
Dockerfile f76bbbf5e6 chore(Dockerfile): Bump expat to 2.6.2-2 (#7904) пре 1 година
README.md fb5e3662d5 Chores: add missing profile for middleware docker compose cmd and fix ssrf-proxy doc link (#6372) пре 1 година
app.py 3571292fbf chore(api): Introduce Ruff Formatter. (#7291) пре 1 година
commands.py ceb2b150ff enhance: include workspace name in create-tenant command (#7834) пре 1 година
poetry.lock 954580a4af feat: support more model types and builtin tools on aws/sagemaker (#8061) пре 1 година
poetry.toml f62f71a81a build: initial support for poetry build tool (#4513) пре 1 година
pyproject.toml 954580a4af feat: support more model types and builtin tools on aws/sagemaker (#8061) пре 1 година

README.md

Dify Backend API

Usage

[!IMPORTANT] In the v0.6.12 release, we deprecated pip as the package management tool for Dify API Backend service and replaced it with poetry.

  1. Start the docker-compose stack

The backend require some middleware, including PostgreSQL, Redis, and Weaviate, which can be started together using docker-compose.

   cd ../docker
   cp middleware.env.example middleware.env
   # change the profile to other vector database if you are not using weaviate
   docker compose -f docker-compose.middleware.yaml --profile weaviate -p dify up -d
   cd ../api
  1. Copy .env.example to .env
  2. Generate a SECRET_KEY in the .env file.

```bash for Linux sed -i "/^SECRET_KEY=/c\SECRET_KEY=$(openssl rand -base64 42)" .env


   ```bash for Mac
   secret_key=$(openssl rand -base64 42)
   sed -i '' "/^SECRET_KEY=/c\\
   SECRET_KEY=${secret_key}" .env
  1. Create environment.

Dify API service uses Poetry to manage dependencies. You can execute poetry shell to activate the environment.

  1. Install dependencies
   poetry env use 3.10
   poetry install

In case of contributors missing to update dependencies for pyproject.toml, you can perform the following shell instead.

   poetry shell                                               # activate current environment
   poetry add $(cat requirements.txt)           # install dependencies of production and update pyproject.toml
   poetry add $(cat requirements-dev.txt) --group dev    # install dependencies of development and update pyproject.toml
  1. Run migrate

Before the first launch, migrate the database to the latest version.

   poetry run python -m flask db upgrade
  1. Start backend
   poetry run python -m flask run --host 0.0.0.0 --port=5001 --debug
  1. Start Dify web service.
  2. Setup your application by visiting http://localhost:3000...
  3. If you need to debug local async processing, please start the worker service.
   poetry run python -m celery -A app.celery worker -P gevent -c 1 --loglevel INFO -Q dataset,generation,mail,ops_trace,app_deletion

The started celery app handles the async tasks, e.g. dataset importing and documents indexing.

Testing

  1. Install dependencies for both the backend and the test environment
   poetry install --with dev
  1. Run the tests locally with mocked system environment variables in tool.pytest_env section in pyproject.toml
   cd ../
   poetry run -C api bash dev/pytest/pytest_all_tests.sh