Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion code_review.md
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,7 @@ Guides load on demand, so the general passes here stay short.
| `runtime/` state and recovery | serde and replay type fidelity, real failure-path tests | [review-guides/runtime-state-recovery.md](review-guides/runtime-state-recovery.md) |
| Python-Java bridge | cross-language parity, type mapping across Pemja | [review-guides/python-java-bridge.md](review-guides/python-java-bridge.md) |
| `api/` contract | API shape, compatibility policy, deprecation | [review-guides/api-contract.md](review-guides/api-contract.md) |
| `dist` and dependency | shading, LICENSE and NOTICE, dist registration | planned |
| `dist` and dependency | shading, LICENSE and NOTICE, dist registration | [review-guides/dist-dependency.md](review-guides/dist-dependency.md) |
| docs-only | facts match their source of truth | [review-guides/docs-only.md](review-guides/docs-only.md) |

## Required Review Passes
Expand Down
6 changes: 3 additions & 3 deletions dist/src/main/resources/META-INF/NOTICE
Original file line number Diff line number Diff line change
Expand Up @@ -130,9 +130,9 @@ See bundled license files for details.

- io.github.ollama4j:ollama4j:1.1.5
- org.jsoup:jsoup:1.21.2
- com.anthropic:anthropic-java:2.11.1
- com.anthropic:anthropic-java-client-okhttp:2.11.1
- com.anthropic:anthropic-java-core:2.11.1
- com.anthropic:anthropic-java:2.12.0
- com.anthropic:anthropic-java-client-okhttp:2.12.0
- com.anthropic:anthropic-java-core:2.12.0
- org.reactivestreams:reactive-streams:1.0.4
- io.modelcontextprotocol.sdk:mcp:0.16.0
- io.modelcontextprotocol.sdk:mcp-json-jackson2:0.16.0
Expand Down
6 changes: 5 additions & 1 deletion docs/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,12 +22,16 @@ $ docker run -v $(pwd):/src -p 1313:1313 jakejarvis/hugo-extended:latest server

#### Local Hugo installation:

Make sure you have installed [Hugo](https://gohugo.io/getting-started/installing/) on your system.
`setup_hugo.sh` installs Hugo 0.110.0, the version the docs build is pinned to. A newer Hugo release removed an internal template the pinned `hugo-book` theme calls, so building with a current Hugo fails with `no such template "_internal/google_analytics_async.html"`.

On Linux, install it with:

```sh
$ ./setup_hugo.sh
```

`setup_hugo.sh` downloads a Linux binary, x86_64 or ARM64. On other platforms, install the extended Hugo 0.110.0 from the [Hugo releases page](https://github.com/gohugoio/hugo/releases/tag/v0.110.0) yourself.

Then build the docs from source:

```sh
Expand Down
2 changes: 1 addition & 1 deletion docs/content.zh/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,7 @@ under the License.

### Community Sync

我们每周会举行一次在线同步会议,欢迎所有人参与。请查看此 [GitHub 讨论页面](https://github.com/apache/flink-agents/discussions/66) 获取下次会议的时间表、议程以及往期会议记录。
我们每周会举行一次在线同步会议,欢迎所有人参与。请查看此 [GitHub 讨论页面](https://github.com/apache/flink-agents/discussions/419) 获取下次会议的时间表、议程以及往期会议记录。

{{< /columns >}}

Expand Down
14 changes: 13 additions & 1 deletion docs/content/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,6 +30,18 @@ under the License.
If you’re interested in playing around with Flink Agents, check out our [get started documentation]({{< ref "docs/get-started/overview" >}}).
It provides a step by step introduction on how to install Flink Agents and build agents with it.

### Quickstart

* [Workflow Agent]({{< ref "docs/get-started/quickstart/workflow_agent" >}}) - Define agent logic as an explicit event-driven workflow
* [ReAct Agent]({{< ref "docs/get-started/quickstart/react_agent" >}}) - Let the model plan and call tools in a reason-act loop
* [YAML Agent]({{< ref "docs/get-started/quickstart/yaml_agent" >}}) - Configure an agent declaratively in YAML

### Build and Operate

* [Chat Models]({{< ref "docs/development/chat_models" >}}), [Tools]({{< ref "docs/development/tool_use" >}}) and [Memory]({{< ref "docs/development/memory/overview" >}}) - The building blocks of an agent
* [Integrate with Flink]({{< ref "docs/development/integrate_with_flink" >}}) - Run an agent inside a Flink job
* [Deployment]({{< ref "docs/operations/deployment" >}}) and [Monitoring]({{< ref "docs/operations/monitoring" >}}) - Take an agent to production

<--->

## Get Help with Flink Agents
Expand All @@ -44,7 +56,7 @@ See the [Apache Flink website](https://flink.apache.org/what-is-flink/community/

### Community Sync

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](https://github.com/apache/flink-agents/discussions/66).
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](https://github.com/apache/flink-agents/discussions/419).

{{< /columns >}}

Expand Down
5 changes: 3 additions & 2 deletions docs/content/docs/development/chat_models.md
Original file line number Diff line number Diff line change
Expand Up @@ -292,6 +292,7 @@ Anthropic provides cloud-based chat models featuring the Claude family, known fo
| `tools` | List[str] | None | List of tool names available to the model |
| `max_tokens` | int | `1024` | Maximum number of tokens to generate |
| `temperature` | float | `0.1` | Sampling temperature (0.0 to 1.0) |
| `json_prefill` | bool | `False` | Prefill assistant response with "{" to enforce JSON output (applies only on models that accept assistant-message prefilling; disabled when tools are used, or when the request carries an `output_config`) |
| `additional_kwargs` | dict | `{}` | Additional Anthropic API parameters |

{{< /tab >}}
Expand All @@ -306,9 +307,9 @@ Anthropic provides cloud-based chat models featuring the Claude family, known fo
| `tools` | List<String> | None | List of tool names available to the model |
| `max_tokens` | long | `1024` | Maximum number of tokens to generate |
| `temperature` | double | `0.1` | Sampling temperature (0.0 to 1.0) |
| `json_prefill` | boolean | `true` | Prefill assistant response with "{" to enforce JSON output (disabled when tools are used) |
| `json_prefill` | boolean | `false` | Prefill assistant response with "{" to enforce JSON output (applies only on models that accept assistant-message prefilling; disabled when tools are used, or when the request carries an `output_config`) |
| `strict_tools` | boolean | `false` | Enable strict mode for tool calling schemas |
| `additional_kwargs` | Map<String, Object> | `{}` | Additional Anthropic API parameters (top_k, top_p, stop_sequences) |
| `additional_kwargs` | Map<String, Object> | `{}` | Additional Anthropic API parameters (top_k, top_p, stop_sequences); an `output_config` supplied here takes precedence over one derived from an output schema |

{{< /tab >}}

Expand Down
12 changes: 12 additions & 0 deletions docs/content/docs/get-started/overview.md
Original file line number Diff line number Diff line change
Expand Up @@ -47,3 +47,15 @@ To get started with Apache Flink Agents, you can checkout the following quicksta
- [ReAct Agent Quickstart]({{< ref "docs/get-started/quickstart/react_agent" >}})
- [Skills Agent Quickstart]({{< ref "docs/get-started/quickstart/skills_agent" >}})
- [YAML Agent Quickstart]({{< ref "docs/get-started/quickstart/yaml_agent" >}})

## Preview Status

{{< hint warning >}}
Apache Flink Agents 0.x releases are preview versions. They may contain known
or unknown issues, including potential security risks. The APIs and
configuration are experimental and may change in backward-incompatible ways
before 1.0. Review the [publicly disclosed known issues](https://github.com/apache/flink-agents/issues)
and assess these risks before production use. Report suspected undisclosed
security vulnerabilities privately through the [ASF Security Team](https://www.apache.org/security/)
instead of creating a public GitHub issue.
{{< /hint >}}
9 changes: 7 additions & 2 deletions docs/setup_hugo.sh
Original file line number Diff line number Diff line change
Expand Up @@ -18,8 +18,13 @@
################################################################################

# setup hugo
HUGO_REPO=https://github.com/gohugoio/hugo/releases/download/v0.110.0/hugo_extended_0.110.0_Linux-64bit.tar.gz
HUGO_ARTIFACT=hugo_extended_0.110.0_Linux-64bit.tar.gz
case "$(uname -m)" in
x86_64) HUGO_ARCH=Linux-64bit ;;
aarch64) HUGO_ARCH=linux-arm64 ;;
*) echo "No Hugo binary for architecture $(uname -m)" ; exit 1 ;;
esac
HUGO_ARTIFACT=hugo_extended_0.110.0_${HUGO_ARCH}.tar.gz
HUGO_REPO=https://github.com/gohugoio/hugo/releases/download/v0.110.0/${HUGO_ARTIFACT}
if ! curl --fail -OL $HUGO_REPO ; then
echo "Failed to download Hugo binary"
exit 1
Expand Down
Loading
Loading