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
9 changes: 5 additions & 4 deletions docs/config.toml
Original file line number Diff line number Diff line change
Expand Up @@ -70,10 +70,11 @@ pygmentsUseClasses = true
contentDir = 'content'
weight = 1

[languages.zh]
languageName = '中文版'
contentDir = 'content.zh'
weight = 2
# TODO: Add Chinese support
# [languages.zh]
# languageName = '中文版'
# contentDir = 'content.zh'
# weight = 2

[module]
[[module.imports.mounts]]
Expand Down
2 changes: 1 addition & 1 deletion docs/content/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ under the License.
{{< columns >}}
## Try Flink Agents

If you’re interested in playing around with Flink Agents, check out our [example codes]({{< ref "docs/try-flink-agents/installation" >}}).
If you’re interested in playing around with Flink Agents, check out our [example codes]({{< ref "docs/get-started/installation" >}}).
It provides a step by step introduction to the APIs and guides you through real applications.

<--->
Expand Down
3 changes: 1 addition & 2 deletions docs/content/docs/development/_index.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,8 @@
---
title: Development
title: How to Build an Agent
icon: <i class="fa fa-code title maindish" aria-hidden="true"></i>
bold: true
bookCollapseSection: true
sectionBreak: true
weight: 2
---
<!--
Expand Down
57 changes: 57 additions & 0 deletions docs/content/docs/development/chat_with_llm.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,57 @@
---
title: Chat with LLM
weight: 3
type: docs
---
<!--
Licensed to the Apache Software Foundation (ASF) under one
or more contributor license agreements. See the NOTICE file
distributed with this work for additional information
regarding copyright ownership. The ASF licenses this file
to you under the Apache License, Version 2.0 (the
"License"); you may not use this file except in compliance
with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing,
software distributed under the License is distributed on an
"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
KIND, either express or implied. See the License for the
specific language governing permissions and limitations
under the License.
-->

## ChatModel

{{< hint warning >}}
**TODO**: What is ChatModel. How to define and ChatModelConnection, and ChatModelSetup. How to reuse ChatModelConnection in ChatModelSetup.

**TODO**: How to send ChatRequestEvent and handle ChatResponseEvent.
{{< /hint >}}

{{< hint warning >}}
**TODO**: List of all built-in Model and configuration, Ollama, Tongyi, etc.
{{< /hint >}}

### Ollama

### Tongyi

## Prompt

{{< hint warning >}}
**TODO**: What is Prompt. What are the differences between Local Prompt and MCP Prompt.
{{< /hint >}}

### Local Prompt

{{< hint warning >}}
**TODO**: How to define and use a Local Prompt.
{{< /hint >}}

### MCP Prompt

{{< hint warning >}}
**TODO**: Link to MCP Prompt documentation.
{{< /hint >}}
45 changes: 45 additions & 0 deletions docs/content/docs/development/embed_and_vector.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,45 @@
---
title: Embed and Vector Search
weight: 4
type: docs
---
<!--
Licensed to the Apache Software Foundation (ASF) under one
or more contributor license agreements. See the NOTICE file
distributed with this work for additional information
regarding copyright ownership. The ASF licenses this file
to you under the Apache License, Version 2.0 (the
"License"); you may not use this file except in compliance
with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing,
software distributed under the License is distributed on an
"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
KIND, either express or implied. See the License for the
specific language governing permissions and limitations
under the License.
-->


## Embedding Model

{{< hint warning >}}
**TODO**: What is Embedding Model. How to define and use EmbedingModelConnection and EmbedingModelSetup.

{{< /hint >}}

{{< hint warning >}}
**TODO**: List of all built-in Embedding Model and configuration.
{{< /hint >}}

## Vector Store

{{< hint warning >}}
**TODO**: What is Vector Store. How to define and use VectorStoreConnection and VectorStoreSetup.
{{< /hint >}}

{{< hint warning >}}
**TODO**: How to use a Vector Store. List of all built-in Vector Store and configuration.
{{< /hint >}}
35 changes: 35 additions & 0 deletions docs/content/docs/development/integrate_with_flink.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,35 @@
---
title: Integrate with Flink
weight: 6
type: docs
---
<!--
Licensed to the Apache Software Foundation (ASF) under one
or more contributor license agreements. See the NOTICE file
distributed with this work for additional information
regarding copyright ownership. The ASF licenses this file
to you under the Apache License, Version 2.0 (the
"License"); you may not use this file except in compliance
with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing,
software distributed under the License is distributed on an
"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
KIND, either express or implied. See the License for the
specific language governing permissions and limitations
under the License.
-->

## From/To Flink DataStream API

{{< hint warning >}}
**TODO**: How to integrate with Flink DataStream API.
{{< /hint >}}

## From/To Flink Table API

{{< hint warning >}}
**TODO**: How to integrate with Flink Table API.
{{< /hint >}}
35 changes: 35 additions & 0 deletions docs/content/docs/development/react_agent.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,35 @@
---
title: ReAct Agent
weight: 1
type: docs
---
<!--
Licensed to the Apache Software Foundation (ASF) under one
or more contributor license agreements. See the NOTICE file
distributed with this work for additional information
regarding copyright ownership. The ASF licenses this file
to you under the Apache License, Version 2.0 (the
"License"); you may not use this file except in compliance
with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing,
software distributed under the License is distributed on an
"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
KIND, either express or implied. See the License for the
specific language governing permissions and limitations
under the License.
-->

## Overview

{{< hint warning >}}
**TODO**: What is ReAct agent. When to use it.
{{< /hint >}}

## ReAct Agent Example

{{< hint warning >}}
**TODO**: Add the quickstart example code here. And briefly explain the code component by component. Link to the detailed documentation for each component, such as ChatModel, Prompt, Tool, etc.
{{< /hint >}}
54 changes: 54 additions & 0 deletions docs/content/docs/development/tool_use.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,54 @@
---
title: Tool Use
weight: 5
type: docs
---
<!--
Licensed to the Apache Software Foundation (ASF) under one
or more contributor license agreements. See the NOTICE file
distributed with this work for additional information
regarding copyright ownership. The ASF licenses this file
to you under the Apache License, Version 2.0 (the
"License"); you may not use this file except in compliance
with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing,
software distributed under the License is distributed on an
"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
KIND, either express or implied. See the License for the
specific language governing permissions and limitations
under the License.
-->


## Local Function as Tool

{{< hint warning >}}
**TODO**: How to define and use a Local Function as Tool.
{{< /hint >}}

## How to Integrate with MCP Server

{{< hint warning >}}
**TODO**: How to integrate with MCP Server.
{{< /hint >}}

### MCP Tools

{{< hint warning >}}
**TODO**: How to use the tools provided by MCP Server.
{{< /hint >}}

### MCP Prompt

{{< hint warning >}}
**TODO**: How to use the prompts provided by MCP Server.
{{< /hint >}}

## Built-in Events for Tool

{{< hint warning >}}
**TODO**: How to use the built-in events for tool call request and tool call response, such as ToolRequestEvent and ToolResponseEvent.
{{< /hint >}}
Loading