| commit | 48c62b2a75bd9dae6dd033c93c55cb154410747e | [log] [tgz] |
|---|---|---|
| author | Alan Z. <shuai.xyz@gmail.com> | Sat Oct 04 05:14:55 2025 -0700 |
| committer | GitHub <noreply@github.com> | Sat Oct 04 20:14:55 2025 +0800 |
| tree | c71333ded59cdaf3dbb2fd0e8f88d3979f2ef9a1 | |
| parent | aae8a3820daabeb55726de998bce5328fbe22419 [diff] |
[docs] Add docs for chat models and prompts (#245)
Apache Flink Agents is an Agentic AI framework based on Apache Flink.
Prerequisites for building Flink Agents:
To clone from git, enter:
git clone https://github.com/apache/flink-agents.git
To build Flink Agents Java part, run:
cd flink-agents mvn clean install -DskipTests
cd python # Install uv (fast Python package manager) pip install uv # Create env and install build dependencies uv sync --extra build # Build sdist and wheel into python/dist/ uv run python -m build # Install the built wheel into the environment uv pip install dist/*.whl
cd python # Install project (editable) with 'build' extra/tools pip install -e .[build] # Build sdist and wheel into python/dist/ python -m build # Install the built wheel into the environment python -m pip install dist/*.whl
This will also package flink-agents jars in wheel, which is necessary when run agent as pyflink job.
# Build java and python bash -x tools/build.sh # Skip building java (must be built already) bash -x tools/build.sh -p
See the Apache Flink website for how to join the slack workspace. We use #flink-agents-dev for developement related discussions.
There is a weekly online sync. Everyone is welcome to join. Please find the schedule, agenda for the next sync, and records of previous syncs in this github discussion page.