Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat: Minor Improvement: Add suppressInitialMessage to webSearch Action #2066

Closed
wants to merge 3 commits into from
Closed

feat: Minor Improvement: Add suppressInitialMessage to webSearch Action #2066

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
cd71c26
Chore: clean websearch
chuasonglin1995 Jan 9, 2025
20bd15d
Merge branch 'develop' into main
monilpat Jan 11, 2025
6ebdb8b
add suppressInitialMessage to webSearch
chuasonglin1995 Jan 12, 2025
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
200 changes: 200 additions & 0 deletions packages/plugin-web-search/src/actions/webSearch.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,200 @@
import { elizaLogger } from "@elizaos/core";
import {
Action,
HandlerCallback,
IAgentRuntime,
Memory,
State,
} from "@elizaos/core";
import { generateWebSearch } from "@elizaos/core";
import { SearchResult } from "@elizaos/core";
import { encodingForModel, TiktokenModel } from "js-tiktoken";

const DEFAULT_MAX_WEB_SEARCH_TOKENS = 4000;
const DEFAULT_MODEL_ENCODING = "gpt-3.5-turbo";

function getTotalTokensFromString(
str: string,
encodingName: TiktokenModel = DEFAULT_MODEL_ENCODING
) {
const encoding = encodingForModel(encodingName);
return encoding.encode(str).length;
}

function MaxTokens(
data: string,
maxTokens: number = DEFAULT_MAX_WEB_SEARCH_TOKENS
): string {
if (getTotalTokensFromString(data) >= maxTokens) {
return data.slice(0, maxTokens);
}
return data;
}

export const webSearch: Action = {
name: "WEB_SEARCH",
similes: [
"SEARCH_WEB",
"INTERNET_SEARCH",
"LOOKUP",
"QUERY_WEB",
"FIND_ONLINE",
"SEARCH_ENGINE",
"WEB_LOOKUP",
"ONLINE_SEARCH",
"FIND_INFORMATION",
],
description:
"Perform a web search to find information related to the message.",
validate: async (runtime: IAgentRuntime, message: Memory) => {
const tavilyApiKeyOk = !!runtime.getSetting("TAVILY_API_KEY");

return tavilyApiKeyOk;
},
handler: async (
runtime: IAgentRuntime,
message: Memory,
state: State,
options: any,
callback: HandlerCallback
) => {
elizaLogger.log("Composing state for message:", message);
state = (await runtime.composeState(message)) as State;
const userId = runtime.agentId;
elizaLogger.log("User ID:", userId);

const webSearchPrompt = message.content.text;
elizaLogger.log("web search prompt received:", webSearchPrompt);

elizaLogger.log("Generating image with prompt:", webSearchPrompt);
const searchResponse = await generateWebSearch(
webSearchPrompt,
runtime
);

if (searchResponse && searchResponse.results.length) {
const responseList = searchResponse.answer
? `${searchResponse.answer}${
Array.isArray(searchResponse.results) &&
searchResponse.results.length > 0
? `\n\nFor more details, you can check out these resources:\n${searchResponse.results
.map(
(result: SearchResult, index: number) =>
`${index + 1}. [${result.title}](${result.url})`
)
.join("\n")}`
: ""
}`
: "";

callback({
text: MaxTokens(responseList, DEFAULT_MAX_WEB_SEARCH_TOKENS),
});
} else {
elizaLogger.error("search failed or returned no data.");
}
},
examples: [
[
{
user: "{{user1}}",
content: {
text: "Find the latest news about SpaceX launches.",
},
},
{
user: "{{agentName}}",
content: {
text: "Here is the latest news about SpaceX launches:",
action: "WEB_SEARCH",
},
},
],
[
{
user: "{{user1}}",
content: {
text: "Can you find details about the iPhone 16 release?",
},
},
{
user: "{{agentName}}",
content: {
text: "Here are the details I found about the iPhone 16 release:",
action: "WEB_SEARCH",
},
},
],
[
{
user: "{{user1}}",
content: {
text: "What is the schedule for the next FIFA World Cup?",
},
},
{
user: "{{agentName}}",
content: {
text: "Here is the schedule for the next FIFA World Cup:",
action: "WEB_SEARCH",
},
},
],
[
{
user: "{{user1}}",
content: { text: "Check the latest stock price of Tesla." },
},
{
user: "{{agentName}}",
content: {
text: "Here is the latest stock price of Tesla I found:",
action: "WEB_SEARCH",
},
},
],
[
{
user: "{{user1}}",
content: {
text: "What are the current trending movies in the US?",
},
},
{
user: "{{agentName}}",
content: {
text: "Here are the current trending movies in the US:",
action: "WEB_SEARCH",
},
},
],
[
{
user: "{{user1}}",
content: {
text: "What is the latest score in the NBA finals?",
},
},
{
user: "{{agentName}}",
content: {
text: "Here is the latest score from the NBA finals:",
action: "WEB_SEARCH",
},
},
],
[
{
user: "{{user1}}",
content: { text: "When is the next Apple keynote event?" },
},
{
user: "{{agentName}}",
content: {
text: "Here is the information about the next Apple keynote event:",
action: "WEB_SEARCH",
},
},
],
],
} as Action;
Loading
Loading