Skip to content

Commit 3351f48

Browse files
orpiskeorpiske
committed
Add search capabilities with Tavily
1 parent 73ffc92 commit 3351f48

File tree

9 files changed

+487
-5
lines changed

9 files changed

+487
-5
lines changed

‎core/core-exchange/src/main/java/ai/wanaku/core/exchange/ParsedToolInvokeRequest.java

+16
Original file line numberDiff line numberDiff line change
@@ -6,8 +6,24 @@
66

77
public record ParsedToolInvokeRequest(String uri, String body) {
88

9+
/**
10+
* Parses the URI provided by the router
11+
* @param toolInvokeRequest the invocation request (containing the arguments and the request URI)
12+
* @return the parsed URI and its body
13+
*/
914
public static ParsedToolInvokeRequest parseRequest(ToolInvokeRequest toolInvokeRequest) {
1015
String uri = toolInvokeRequest.getUri();
16+
return parseRequest(uri, toolInvokeRequest);
17+
}
18+
19+
/**
20+
* Parses a URI, ignoring the one provided by the router. This is used for services that rely on simplified
21+
* tools/resources URI to hide the complexity of the implementation details (i.e.: such as overly complex Camel URIs).
22+
* @param uri the actual URI that will be parsed. The parameters will be merged w/ the provided URI from the router.
23+
* @param toolInvokeRequest the invocation request (containing the arguments and the request URI)
24+
* @return the parsed URI and its body
25+
*/
26+
public static ParsedToolInvokeRequest parseRequest(String uri, ToolInvokeRequest toolInvokeRequest) {
1127
String body = null;
1228
for (var t : toolInvokeRequest.getArgumentsMap().entrySet()) {
1329
if (!t.getKey().equals("_body")) {

‎docs/usage.md

+6-5
Original file line numberDiff line numberDiff line change
@@ -236,11 +236,12 @@ The following resources can be made available using Wanaku.
236236

237237
The following tools services can be made available using Wanaku and used to provide access to specific services.
238238

239-
| Type | Service Tool | Description |
240-
|--------------|-----------------------------------|----------------------------------------------------------|
241-
| `http` | wanaku-routing-http-service | Provides access to HTTP endpoints as tools via Wanaku |
242-
| `yaml-route` | wanaku-routing-yaml-route-service | Provides access to Camel routes in YAML tools via Wanaku |
243-
| `kafka` | wanaku-routing-kafka-service | Provides access to Kafka topics as tools via Wanaku |
239+
| Type | Service Tool | Description |
240+
|--------------|-----------------------------------|-----------------------------------------------------------------------------|
241+
| `http` | wanaku-routing-http-service | Provides access to HTTP endpoints as tools via Wanaku |
242+
| `yaml-route` | wanaku-routing-yaml-route-service | Provides access to Camel routes in YAML tools via Wanaku |
243+
| `kafka` | wanaku-routing-kafka-service | Provides access to Kafka topics as tools via Wanaku |
244+
| `tavily` | wanaku-routing-tavily-service | Provides search capabilities on the Web using [Tavily](https://tavily.com/) |
244245

245246

246247
## Adding Your Own Resource Provider or Tool Service

‎services/tools/pom.xml

+1
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,7 @@
1616
<module>wanaku-routing-http-service</module>
1717
<module>wanaku-routing-kafka-service</module>
1818
<module>wanaku-routing-yaml-route-service</module>
19+
<module>wanaku-routing-tavily-service</module>
1920
</modules>
2021

2122
</project>

‎services/tools/wanaku-routing-tavily-service/README.md

+12
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
# Wanaku Tool - Tavily
2+
3+
A service that searches on the Web using [Tavily](https://tavily.com/).
4+
5+
To run set your API key using either one of:
6+
7+
- the environment variable `TAVILY_API_KEY`
8+
- the `tavily.api.key` property when running the application (i.e.: `-Dtavily.api.key=my-key`)
9+
10+
```shell
11+
wanaku tools add -n "tavily-search" --description "Search on the internet using Tavily" --uri "tavily://search?maxResults={maxResults}" --type tavily --property "_body:string,The search terms" --property "maxResults:int,The maxResults is the expected number of results to be found if the search request were made" --required "_body"
12+
```

‎services/tools/wanaku-routing-tavily-service/pom.xml

+223
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,223 @@
1+
<?xml version="1.0" encoding="UTF-8"?>
2+
<!--
3+
~ Licensed to the Apache Software Foundation (ASF) under one or more
4+
~ contributor license agreements. See the NOTICE file distributed with
5+
~ this work for additional information regarding copyright ownership.
6+
~ The ASF licenses this file to You under the Apache License, Version 2.0
7+
~ (the "License"); you may not use this file except in compliance with
8+
~ the License. You may obtain a copy of the License at
9+
~
10+
~ http://www.apache.org/licenses/LICENSE-2.0
11+
~
12+
~ Unless required by applicable law or agreed to in writing, software
13+
~ distributed under the License is distributed on an "AS IS" BASIS,
14+
~ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
15+
~ See the License for the specific language governing permissions and
16+
~ limitations under the License.
17+
-->
18+
19+
<project xmlns="http://maven.apache.org/POM/4.0.0"
20+
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
21+
xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
22+
<modelVersion>4.0.0</modelVersion>
23+
<parent>
24+
<groupId>ai.wanaku</groupId>
25+
<artifactId>tools</artifactId>
26+
<version>0.0.2-SNAPSHOT</version>
27+
</parent>
28+
29+
<artifactId>wanaku-routing-tavily-service</artifactId>
30+
<name>Wanaku :: Service :: Tools :: Tavily</name>
31+
32+
<dependencyManagement>
33+
<dependencies>
34+
<dependency>
35+
<groupId>${quarkus.platform.group-id}</groupId>
36+
<artifactId>${quarkus.platform.artifact-id}</artifactId>
37+
<version>${quarkus.platform.version}</version>
38+
<type>pom</type>
39+
<scope>import</scope>
40+
</dependency>
41+
42+
<dependency>
43+
<groupId>${quarkus.platform.group-id}</groupId>
44+
<artifactId>quarkus-camel-bom</artifactId>
45+
<version>${quarkus.platform.version}</version>
46+
<type>pom</type>
47+
<scope>import</scope>
48+
</dependency>
49+
</dependencies>
50+
</dependencyManagement>
51+
52+
<dependencies>
53+
<dependency>
54+
<groupId>ai.wanaku</groupId>
55+
<artifactId>core-exchange</artifactId>
56+
<version>${project.version}</version>
57+
</dependency>
58+
59+
<dependency>
60+
<groupId>ai.wanaku</groupId>
61+
<artifactId>core-services</artifactId>
62+
<version>${project.version}</version>
63+
</dependency>
64+
65+
<dependency>
66+
<groupId>ai.wanaku</groupId>
67+
<artifactId>core-service-discovery</artifactId>
68+
<version>${project.version}</version>
69+
</dependency>
70+
71+
<dependency>
72+
<groupId>io.quarkus</groupId>
73+
<artifactId>quarkus-arc</artifactId>
74+
</dependency>
75+
76+
<dependency>
77+
<groupId>io.quarkus</groupId>
78+
<artifactId>quarkus-grpc</artifactId>
79+
</dependency>
80+
81+
<dependency>
82+
<groupId>org.apache.camel.quarkus</groupId>
83+
<artifactId>camel-quarkus-core</artifactId>
84+
</dependency>
85+
86+
<dependency>
87+
<groupId>org.apache.camel.quarkus</groupId>
88+
<artifactId>camel-quarkus-langchain4j-web-search</artifactId>
89+
</dependency>
90+
91+
<dependency>
92+
<groupId>dev.langchain4j</groupId>
93+
<artifactId>langchain4j-web-search-engine-tavily</artifactId>
94+
</dependency>
95+
96+
97+
<!-- For building containers -->
98+
<dependency>
99+
<groupId>io.quarkus</groupId>
100+
<artifactId>quarkus-container-image-jib</artifactId>
101+
</dependency>
102+
103+
<!-- Tool dependencies go here -->
104+
105+
</dependencies>
106+
107+
<build>
108+
<plugins>
109+
<plugin>
110+
<groupId>${quarkus.platform.group-id}</groupId>
111+
<artifactId>quarkus-maven-plugin</artifactId>
112+
<version>${quarkus.platform.version}</version>
113+
<extensions>true</extensions>
114+
<executions>
115+
<execution>
116+
<goals>
117+
<goal>build</goal>
118+
<goal>generate-code</goal>
119+
<goal>generate-code-tests</goal>
120+
</goals>
121+
</execution>
122+
</executions>
123+
</plugin>
124+
</plugins>
125+
</build>
126+
127+
<profiles>
128+
<profile>
129+
<id>native</id>
130+
<activation>
131+
<property>
132+
<name>native</name>
133+
</property>
134+
</activation>
135+
<properties>
136+
<skipITs>false</skipITs>
137+
<quarkus.native.enabled>true</quarkus.native.enabled>
138+
</properties>
139+
</profile>
140+
<profile>
141+
<id>dist</id>
142+
<build>
143+
<plugins>
144+
<plugin>
145+
<groupId>org.apache.maven.plugins</groupId>
146+
<artifactId>maven-assembly-plugin</artifactId>
147+
<version>${maven-assembly-plugin.version}</version>
148+
<configuration>
149+
<attach>false</attach>
150+
<appendAssemblyId>false</appendAssemblyId>
151+
<outputDirectory>${distribution.directory}</outputDirectory>
152+
<workDirectory>${project.build.directory}/assembly/work</workDirectory>
153+
</configuration>
154+
<executions>
155+
<execution>
156+
<id>make-distribution</id>
157+
<phase>package</phase>
158+
<goals>
159+
<goal>single</goal>
160+
</goals>
161+
<configuration>
162+
<finalName>${project.artifactId}-${project.version}</finalName>
163+
<descriptors>
164+
<descriptor>src/main/assembly/assembly.xml</descriptor>
165+
</descriptors>
166+
</configuration>
167+
</execution>
168+
</executions>
169+
</plugin>
170+
</plugins>
171+
</build>
172+
</profile>
173+
<profile>
174+
<id>dist-native</id>
175+
<activation>
176+
<property>
177+
<name>native</name>
178+
</property>
179+
</activation>
180+
<build>
181+
<plugins>
182+
<plugin>
183+
<groupId>org.apache.maven.plugins</groupId>
184+
<artifactId>maven-assembly-plugin</artifactId>
185+
<version>${maven-assembly-plugin.version}</version>
186+
<configuration>
187+
<attach>false</attach>
188+
<appendAssemblyId>false</appendAssemblyId>
189+
<outputDirectory>${distribution.directory}</outputDirectory>
190+
<workDirectory>${project.build.directory}/assembly/work</workDirectory>
191+
</configuration>
192+
<executions>
193+
<execution>
194+
<id>make-native-distribution</id>
195+
<phase>package</phase>
196+
<goals>
197+
<goal>single</goal>
198+
</goals>
199+
<configuration>
200+
<finalName>${project.artifactId}-${project.version}-${os.detected.classifier}</finalName>
201+
<descriptors>
202+
<descriptor>src/main/assembly/assembly-native.xml</descriptor>
203+
</descriptors>
204+
</configuration>
205+
</execution>
206+
</executions>
207+
</plugin>
208+
</plugins>
209+
</build>
210+
</profile>
211+
<profile>
212+
<id>dist-windows</id>
213+
<activation>
214+
<os>
215+
<family>windows</family>
216+
</os>
217+
</activation>
218+
<properties>
219+
<executable-suffix>.exe</executable-suffix>
220+
</properties>
221+
</profile>
222+
</profiles>
223+
</project>

‎services/tools/wanaku-routing-tavily-service/src/main/java/ai/wanaku/routing/service/InvocationService.java

+80
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,80 @@
1+
/*
2+
* Licensed to the Apache Software Foundation (ASF) under one or more
3+
* contributor license agreements. See the NOTICE file distributed with
4+
* this work for additional information regarding copyright ownership.
5+
* The ASF licenses this file to You under the Apache License, Version 2.0
6+
* (the "License"); you may not use this file except in compliance with
7+
* the License. You may obtain a copy of the License at
8+
*
9+
* http://www.apache.org/licenses/LICENSE-2.0
10+
*
11+
* Unless required by applicable law or agreed to in writing, software
12+
* distributed under the License is distributed on an "AS IS" BASIS,
13+
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14+
* See the License for the specific language governing permissions and
15+
* limitations under the License.
16+
*/
17+
18+
package ai.wanaku.routing.service;
19+
20+
import jakarta.enterprise.event.Observes;
21+
import jakarta.inject.Inject;
22+
23+
import ai.wanaku.core.exchange.InquireReply;
24+
import ai.wanaku.core.exchange.InquireRequest;
25+
import ai.wanaku.core.exchange.Inquirer;
26+
import ai.wanaku.core.exchange.InvocationDelegate;
27+
import ai.wanaku.core.exchange.ToolInvokeReply;
28+
import ai.wanaku.core.exchange.ToolInvokeRequest;
29+
import ai.wanaku.core.exchange.ToolInvoker;
30+
import ai.wanaku.core.service.discovery.util.DiscoveryUtil;
31+
import ai.wanaku.core.services.config.WanakuRoutingConfig;
32+
import io.quarkus.grpc.GrpcService;
33+
import io.quarkus.runtime.ShutdownEvent;
34+
import io.quarkus.runtime.StartupEvent;
35+
import io.smallrye.common.annotation.Blocking;
36+
import io.smallrye.mutiny.Uni;
37+
import org.eclipse.microprofile.config.inject.ConfigProperty;
38+
import org.jboss.logging.Logger;
39+
40+
@GrpcService
41+
public class InvocationService implements ToolInvoker, Inquirer {
42+
private static final Logger LOG = Logger.getLogger(InvocationService.class);
43+
44+
@Inject
45+
InvocationDelegate delegate;
46+
47+
@Inject
48+
WanakuRoutingConfig config;
49+
50+
@ConfigProperty(name = "quarkus.grpc.server.port")
51+
int port;
52+
53+
@Blocking
54+
@Override
55+
public Uni<ToolInvokeReply> invokeTool(ToolInvokeRequest request) {
56+
return Uni.createFrom().item(() -> delegate.invoke(request));
57+
}
58+
59+
@Override
60+
public Uni<InquireReply> inquire(InquireRequest request) {
61+
InquireReply reply = InquireReply.newBuilder()
62+
.putAllServiceConfigurations(delegate.serviceConfigurations())
63+
.putAllCredentialsConfigurations(delegate.credentialsConfigurations())
64+
.build();
65+
66+
return Uni.createFrom().item(() -> reply);
67+
}
68+
69+
void register(@Observes StartupEvent ev) {
70+
LOG.info("Registering tool service");
71+
72+
delegate.register(config.name(), DiscoveryUtil.resolveRegistrationAddress(), port);
73+
}
74+
75+
void deregister(@Observes ShutdownEvent ev) {
76+
LOG.info("De-registering tool service");
77+
78+
delegate.deregister(config.name(), DiscoveryUtil.resolveRegistrationAddress(), port);
79+
}
80+
}

0 commit comments

Comments
 (0)