Skip to content

Commit fb5e0bf

Browse files
committed
Update README
1 parent 1bbeba7 commit fb5e0bf

File tree

3 files changed

+50
-27
lines changed

3 files changed

+50
-27
lines changed

README.md

Lines changed: 21 additions & 27 deletions
Original file line numberDiff line numberDiff line change
@@ -16,9 +16,7 @@
1616

1717
    
1818

19-
# Generated agent
20-
21-
Java agent repository generated by the Embabel project creator.
19+
# Generated Agent Project
2220

2321
Starting point for your own agent development using the [Embabel framework](https://github.com/embabel/embabel-agent).
2422

@@ -31,7 +29,10 @@ Illustrates:
3129
- A simple agent
3230
- Unit tests for an agent verifying prompts and hyperparameters
3331

34-
# To run
32+
> For the Kotlin equivalent, see
33+
> our [Kotlin agent template](https://github.com/embabel/kotlin-agent-template).
34+
35+
# Running
3536

3637
Run the shell script to start Embabel under Spring Shell:
3738

@@ -43,47 +44,40 @@ There is a single example agent, `WriteAndReviewAgent`.
4344
It uses one LLM with a high temperature and creative persona to write a story based on your input,
4445
then another LLM with a low temperature and different persona to review the story.
4546

46-
When the Embabel shell comes up, use the story agent like this:
47+
When the Embabel shell comes up, invoke the story agent like this:
4748

4849
```
4950
x "Tell me a story about...[your topic]"
5051
```
5152

52-
Try the `InjectedDemo` command to see simple, non-agent use:
53+
Try the `InjectedDemo` command to see simple, non-agent use.
54+
Type this in the interactive shell to see a single prompt create
55+
an imaginary animal:
5356

5457
```java
5558
animal
5659
```
5760

58-
## A2A Support
59-
60-
Embabel integrates with the [A2A](https://github.com/google-a2a/A2A) protocol, allowing you to connect to other
61-
A2A-enabled agents and
62-
services.
63-
64-
> Embabel agents can be exposed to A2A with zero developer effort.
61+
## Suggested Next Steps
6562

66-
Check out the `a2a` branch of this repository to try A2A support.
63+
To get a feel for working with Embabel, try the following:
6764

68-
You'll need the following environment variable:
65+
- Modify the prompts in `WriteAndReviewAgent` and `InjectedDemo`.
66+
- Experiment with different models and hyperparameters by modifying `withLlm` calls.
67+
- Integrate your own services, injecting them with Spring. All Embabel `@Agent` classes are Spring beans.
68+
- Run the tests with `mvn test` and modify them to experiment with prompt verification.
6969

70-
- `GOOGLE_STUDIO_API_KEY`: Your Google Studio API key, which is used for Gemini.
70+
## Model support
7171

72-
Start the Google A2A web interface using Docker compose:
73-
74-
```bash
75-
docker compose up
76-
```
72+
Embabel integrates with any LLM supported by Spring AI.
7773

78-
Go to the web interface running within the container at `http://localhost:12000/`.
74+
See [LLM integration guide](docs/llm-docs.md) (work in progress).
7975

80-
Connect to your agent at `host.docker.internal:8080/a2a`. Note that `localhost:8080/a2a` won't work as the server
81-
cannot access it when running in a Docker container.
76+
Also see [Spring AI models](https://docs.spring.io/spring-ai/reference/api/index.html).
8277

83-
Your agent will have automatically been exported to A2A. Add it in the UI, and start a chat.
84-
You should see something like this:
78+
## A2A support
8579

86-
<img src="images/a2a_ui.jpg" alt="A2A UI" width="600">
80+
Embabel integrates with Google A2a. See [A2A integration](docs/a2a.md).
8781

8882
## Contributors
8983

docs/a2a.md

Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
# A2A Support
2+
3+
Embabel integrates with the [A2A](https://github.com/google-a2a/A2A) protocol, allowing you to connect to other
4+
A2A-enabled agents and
5+
services.
6+
7+
> Embabel agents can be exposed to A2A with zero developer effort.
8+
9+
Check out the `a2a` branch of this repository to try A2A support.
10+
11+
You'll need the following environment variable:
12+
13+
- `GOOGLE_STUDIO_API_KEY`: Your Google Studio API key, which is used for Gemini.
14+
15+
Start the Google A2A web interface using Docker compose:
16+
17+
```bash
18+
docker compose up
19+
```
20+
21+
Go to the web interface running within the container at `http://localhost:12000/`.
22+
23+
Connect to your agent at `host.docker.internal:8080/a2a`. Note that `localhost:8080/a2a` won't work as the server
24+
cannot access it when running in a Docker container.
25+
26+
Your agent will have automatically been exported to A2A. Add it in the UI, and start a chat.
27+
You should see something like this:
28+
29+
<img src="images/a2a_ui.jpg" alt="A2A UI" width="600">
File renamed without changes.

0 commit comments

Comments
 (0)