This is an automated email from the ASF dual-hosted git repository.
wenjin272 pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/flink-agents.git
The following commit(s) were added to refs/heads/main by this push:
new 01495962 [docs][yaml] Polish yaml doc and add bedrock alias (#812)
01495962 is described below
commit 01495962e0e661a1640436fc6464250f7bff0ba0
Author: Wenjin Xie <[email protected]>
AuthorDate: Mon Jun 8 19:43:54 2026 +0800
[docs][yaml] Polish yaml doc and add bedrock alias (#812)
Co-authored-by: Claude Opus 4.8 (1M context) <[email protected]>
---
.../org/apache/flink/agents/api/yaml/Aliases.java | 4 +++
docs/content/docs/development/yaml.md | 40 ++++++++++++++++++++--
python/flink_agents/api/yaml/aliases.py | 4 +++
3 files changed, 46 insertions(+), 2 deletions(-)
diff --git a/api/src/main/java/org/apache/flink/agents/api/yaml/Aliases.java
b/api/src/main/java/org/apache/flink/agents/api/yaml/Aliases.java
index f7b2479d..9a60b1ad 100644
--- a/api/src/main/java/org/apache/flink/agents/api/yaml/Aliases.java
+++ b/api/src/main/java/org/apache/flink/agents/api/yaml/Aliases.java
@@ -87,6 +87,7 @@ public final class Aliases {
chatConnJava.put("openai_responses",
ResourceName.ChatModel.OPENAI_RESPONSES_CONNECTION);
chatConnJava.put("anthropic",
ResourceName.ChatModel.ANTHROPIC_CONNECTION);
chatConnJava.put("azure", ResourceName.ChatModel.AZURE_CONNECTION);
+ chatConnJava.put("bedrock", ResourceName.ChatModel.BEDROCK_CONNECTION);
Map<String, String> chatConnPython = new HashMap<>();
chatConnPython.put("ollama",
ResourceName.ChatModel.Python.OLLAMA_CONNECTION);
chatConnPython.put("openai",
ResourceName.ChatModel.Python.OPENAI_COMPLETIONS_CONNECTION);
@@ -102,6 +103,7 @@ public final class Aliases {
chatJava.put("openai_responses",
ResourceName.ChatModel.OPENAI_RESPONSES_SETUP);
chatJava.put("anthropic", ResourceName.ChatModel.ANTHROPIC_SETUP);
chatJava.put("azure", ResourceName.ChatModel.AZURE_SETUP);
+ chatJava.put("bedrock", ResourceName.ChatModel.BEDROCK_SETUP);
Map<String, String> chatPython = new HashMap<>();
chatPython.put("ollama", ResourceName.ChatModel.Python.OLLAMA_SETUP);
chatPython.put("openai",
ResourceName.ChatModel.Python.OPENAI_COMPLETIONS_SETUP);
@@ -113,6 +115,7 @@ public final class Aliases {
// EMBEDDING_MODEL_CONNECTION
Map<String, String> embConnJava = new HashMap<>();
embConnJava.put("ollama",
ResourceName.EmbeddingModel.OLLAMA_CONNECTION);
+ embConnJava.put("bedrock",
ResourceName.EmbeddingModel.BEDROCK_CONNECTION);
Map<String, String> embConnPython = new HashMap<>();
embConnPython.put("ollama",
ResourceName.EmbeddingModel.Python.OLLAMA_CONNECTION);
embConnPython.put("openai",
ResourceName.EmbeddingModel.Python.OPENAI_CONNECTION);
@@ -124,6 +127,7 @@ public final class Aliases {
// EMBEDDING_MODEL
Map<String, String> embJava = new HashMap<>();
embJava.put("ollama", ResourceName.EmbeddingModel.OLLAMA_SETUP);
+ embJava.put("bedrock", ResourceName.EmbeddingModel.BEDROCK_SETUP);
Map<String, String> embPython = new HashMap<>();
embPython.put("ollama",
ResourceName.EmbeddingModel.Python.OLLAMA_SETUP);
embPython.put("openai",
ResourceName.EmbeddingModel.Python.OPENAI_SETUP);
diff --git a/docs/content/docs/development/yaml.md
b/docs/content/docs/development/yaml.md
index 7b81f58d..be224f94 100644
--- a/docs/content/docs/development/yaml.md
+++ b/docs/content/docs/development/yaml.md
@@ -204,6 +204,17 @@ mcp_servers:
endpoint: http://127.0.0.1:8000/mcp
```
+**Inter-resource references.** Several fields are not values but *name
lookups* into another section, resolved within the agent first and then against
shared resources. In the [single-agent example](#declaring-a-single-agent):
+
+| Field | Refers to | Example |
+|-------|-----------|---------|
+| `chat_model_setups[].connection` | a `chat_model_connections[]` name |
`connection: ollama_server` |
+| `chat_model_setups[].prompt` | a `prompts[]` name | `prompt:
review_analysis_prompt` |
+| `chat_model_setups[].tools` | a list of `tools[]` names | `tools:
[notify_shipping_manager]` |
+| `embedding_model_setups[].connection` | an `embedding_model_connections[]`
name | `connection: my_embedding_server` |
+
+The referenced name must exist in the same agent or be a shared resource at
the file level; otherwise loading fails.
+
#### Actions
`actions:` is a list. Each entry is either an inline action **map** or, when
reusing a shared action, a bare **string** referring to the shared action's
name.
@@ -466,9 +477,26 @@ Common chat-model aliases:
| `anthropic` | Anthropic | Anthropic
|
| `azure_openai` | Azure OpenAI (Python) | —
|
| `azure` | — | Azure OpenAI (Java)
|
+| `bedrock` | — | Bedrock (Java)
|
| `tongyi` | Tongyi (Python) | —
|
-Embedding-model and vector-store aliases follow the same scheme. The full
alias tables live in `flink_agents.api.yaml.aliases` (Python) and
`org.apache.flink.agents.api.yaml.Aliases` (Java).
+Embedding-model aliases (apply to both `embedding_model_connections` and
`embedding_model_setups`):
+
+| Alias | `type: python` | `type: java` |
+| --------- | -------------- | -------------- |
+| `ollama` | Ollama | Ollama |
+| `openai` | OpenAI | — |
+| `tongyi` | Tongyi | — |
+| `bedrock` | — | Bedrock (Java) |
+
+Vector-store aliases:
+
+| Alias | `type: python` | `type: java` |
+| --------------- | -------------- | -------------- |
+| `chroma` | Chroma | — |
+| `elasticsearch` | — | Elasticsearch |
+
+The full alias tables live in `flink_agents.api.yaml.aliases` (Python) and
`org.apache.flink.agents.api.yaml.Aliases` (Java).
If `clazz:` is not a known alias, the loader passes it through as-is — write a
fully-qualified class path (e.g.
`flink_agents.integrations.chat_models.ollama_chat_model.OllamaChatModelSetup`)
for providers you've added yourself.
@@ -527,6 +555,8 @@ Loaded with `agents_env.load_yaml(...)` on the Python side,
this produces an age
- `math_chat_model` is a Python Ollama setup that calls a Java function tool
through the cross-language tool bridge.
- `creative_chat_model` is a Java Ollama setup driven from the Python loader
via the Java chat-model wrapper.
+The bridge is symmetric: the same file loaded by the **Java loader** can
declare `type: python` resources, and the Java loader wraps each Python
implementation through its Python wrapper. So a Java-side agent can drive a
Python chat model or call a Python tool, just as the example above drives Java
pieces from the Python loader.
+
Not every resource type is cross-language. Currently `actions`, `tools`,
`chat_model_connections`, `chat_model_setups`, `embedding_model_connections`,
`embedding_model_setups`, and `vector_stores` support `type:` on the opposite
language; others (e.g. `mcp_servers`) do not.
## YAML API Specification
@@ -547,7 +577,13 @@ When loading a YAML file, both runtimes parse it into
typed in-memory representa
### Consistency guarantees
-Because Pydantic models are easier to author and evolve than raw JSON Schema,
the **ground truth** is the Pydantic spec — the checked-in
`docs/yaml-schema.json` is exported from it. Continuous tests then verify
cross-runtime consistency:
+Because Pydantic models are easier to author and evolve than raw JSON Schema,
the **ground truth** is the Pydantic spec — the checked-in
`docs/yaml-schema.json` is exported from it. After changing the specs,
regenerate the schema with:
+
+```bash
+python -m flink_agents.api.yaml.specs > docs/yaml-schema.json
+```
+
+Continuous tests then verify cross-runtime consistency:
- the JSON Schema exported by the Pydantic specs matches the checked-in
`docs/yaml-schema.json`;
- the JSON Schema exported by the Java POJOs matches the checked-in
`docs/yaml-schema.json`;
diff --git a/python/flink_agents/api/yaml/aliases.py
b/python/flink_agents/api/yaml/aliases.py
index 3c80c1b0..cef9b59a 100644
--- a/python/flink_agents/api/yaml/aliases.py
+++ b/python/flink_agents/api/yaml/aliases.py
@@ -73,6 +73,7 @@ CLAZZ_ALIASES: Dict[ResourceType, Dict[str, Dict[str, str]]]
= {
"openai_responses":
ResourceName.ChatModel.Java.OPENAI_RESPONSES_CONNECTION,
"anthropic": ResourceName.ChatModel.Java.ANTHROPIC_CONNECTION,
"azure": ResourceName.ChatModel.Java.AZURE_CONNECTION,
+ "bedrock": ResourceName.ChatModel.Java.BEDROCK_CONNECTION,
},
},
ResourceType.CHAT_MODEL: {
@@ -89,6 +90,7 @@ CLAZZ_ALIASES: Dict[ResourceType, Dict[str, Dict[str, str]]]
= {
"openai_responses":
ResourceName.ChatModel.Java.OPENAI_RESPONSES_SETUP,
"anthropic": ResourceName.ChatModel.Java.ANTHROPIC_SETUP,
"azure": ResourceName.ChatModel.Java.AZURE_SETUP,
+ "bedrock": ResourceName.ChatModel.Java.BEDROCK_SETUP,
},
},
ResourceType.EMBEDDING_MODEL_CONNECTION: {
@@ -99,6 +101,7 @@ CLAZZ_ALIASES: Dict[ResourceType, Dict[str, Dict[str, str]]]
= {
},
"java": {
"ollama": ResourceName.EmbeddingModel.Java.OLLAMA_CONNECTION,
+ "bedrock": ResourceName.EmbeddingModel.Java.BEDROCK_CONNECTION,
},
},
ResourceType.EMBEDDING_MODEL: {
@@ -109,6 +112,7 @@ CLAZZ_ALIASES: Dict[ResourceType, Dict[str, Dict[str,
str]]] = {
},
"java": {
"ollama": ResourceName.EmbeddingModel.Java.OLLAMA_SETUP,
+ "bedrock": ResourceName.EmbeddingModel.Java.BEDROCK_SETUP,
},
},
ResourceType.VECTOR_STORE: {
