fix: serpapi use hg and lg to set region and language

zombieyang · Apr 13, 2023 · 7ebeaad · 7ebeaad
1 parent 3e247e4
commit 7ebeaad
Show file tree

Hide file tree

Showing 20 changed files with 58 additions and 9 deletions.
diff --git a/docs/docs/getting-started/guide-chat.mdx b/docs/docs/getting-started/guide-chat.mdx
@@ -281,6 +281,8 @@ And finally, we can use the AgentExecutor to run an agent:
 const tools = [
   new SerpAPI(process.env.SERPAPI_API_KEY, {
     location: "Austin,Texas,United States",
+    hl: "en",
+    gl: "us",
   }),
 ];
 // Create the agent from the chat model and the tools

diff --git a/docs/docs/getting-started/guide-llm.mdx b/docs/docs/getting-started/guide-llm.mdx
@@ -174,6 +174,8 @@ const model = new OpenAI({ temperature: 0 });
 const tools = [
   new SerpAPI(process.env.SERPAPI_API_KEY, {
     location: "Austin,Texas,United States",
+    hl: "en",
+    gl: "us",
   }),
   new Calculator(),
 ];

diff --git a/docs/docs/modules/agents/executor/getting-started.md b/docs/docs/modules/agents/executor/getting-started.md
@@ -33,6 +33,8 @@ const model = new OpenAI({ temperature: 0 });
 const tools = [
   new SerpAPI(process.env.SERPAPI_API_KEY, {
     location: "Austin,Texas,United States",
+    hl: "en",
+    gl: "us",
   }),
   new Calculator(),
 ];

diff --git a/docs/docs/modules/agents/tools/agents_with_vectorstores.md b/docs/docs/modules/agents/tools/agents_with_vectorstores.md
@@ -50,6 +50,8 @@ Now you can construct and using the tool just as you would any other!
 const tools = [
   new SerpAPI(process.env.SERPAPI_API_KEY, {
     location: "Austin,Texas,United States",
+    hl: "en",
+    gl: "us",
   }),
   new Calculator(),
   qaTool,

diff --git a/docs/docs/production/tracing.md b/docs/docs/production/tracing.md
@@ -21,6 +21,8 @@ export const run = async () => {
   const tools = [
     new SerpAPI(process.env.SERPAPI_API_KEY, {
       location: "Austin,Texas,United States",
+      hl: "en",
+      gl: "us",
     }),
     new Calculator(),
   ];
@@ -63,6 +65,8 @@ export const run = async () => {
   const tools = [
     new SerpAPI(process.env.SERPAPI_API_KEY, {
       location: "Austin,Texas,United States",
+      hl: "en",
+      gl: "us",
     }),
     new Calculator(),
   ];
@@ -103,6 +107,8 @@ export const run = async () => {
     const tools = [
       new SerpAPI(process.env.SERPAPI_API_KEY, {
         location: "Austin,Texas,United States",
+        hl: "en",
+        gl: "us",
       }),
       new Calculator(),
     ];

diff --git a/examples/src/agents/chat_convo_with_tracing.ts b/examples/src/agents/chat_convo_with_tracing.ts
@@ -10,6 +10,8 @@ export const run = async () => {
   const tools = [
     new SerpAPI(process.env.SERPAPI_API_KEY, {
       location: "Austin,Texas,United States",
+      hl: "en",
+      gl: "us",
     }),
     new Calculator(),
   ];

diff --git a/examples/src/agents/chat_mrkl.ts b/examples/src/agents/chat_mrkl.ts
@@ -8,6 +8,8 @@ export const run = async () => {
   const tools = [
     new SerpAPI(process.env.SERPAPI_API_KEY, {
       location: "Austin,Texas,United States",
+      hl: "en",
+      gl: "us",
     }),
     new Calculator(),
   ];

diff --git a/examples/src/agents/chat_mrkl_with_tracing.ts b/examples/src/agents/chat_mrkl_with_tracing.ts
@@ -9,6 +9,8 @@ export const run = async () => {
   const tools = [
     new SerpAPI(process.env.SERPAPI_API_KEY, {
       location: "Austin,Texas,United States",
+      hl: "en",
+      gl: "us",
     }),
     new Calculator(),
   ];

diff --git a/examples/src/agents/concurrent_mrkl.ts b/examples/src/agents/concurrent_mrkl.ts
@@ -15,6 +15,8 @@ export const run = async () => {
   const tools = [
     new SerpAPI(process.env.SERPAPI_API_KEY, {
       location: "Austin,Texas,United States",
+      hl: "en",
+      gl: "us",
     }),
     new Calculator(),
   ];
@@ -55,6 +57,8 @@ export const run = async () => {
     const tools = [
       new SerpAPI(process.env.SERPAPI_API_KEY, {
         location: "Austin,Texas,United States",
+        hl: "en",
+        gl: "us",
       }),
       new Calculator(),
     ];

diff --git a/examples/src/agents/custom_agent.ts b/examples/src/agents/custom_agent.ts
@@ -9,6 +9,8 @@ export const run = async () => {
   const tools = [
     new SerpAPI(process.env.SERPAPI_API_KEY, {
       location: "Austin,Texas,United States",
+      hl: "en",
+      gl: "us",
     }),
     new Calculator(),
   ];

diff --git a/examples/src/agents/custom_llm_agent.ts b/examples/src/agents/custom_llm_agent.ts
@@ -110,6 +110,8 @@ export const run = async () => {
   const tools = [
     new SerpAPI(process.env.SERPAPI_API_KEY, {
       location: "Austin,Texas,United States",
+      hl: "en",
+      gl: "us",
     }),
     new Calculator(),
   ];

diff --git a/examples/src/agents/custom_llm_agent_chat.ts b/examples/src/agents/custom_llm_agent_chat.ts
@@ -113,6 +113,8 @@ export const run = async () => {
   const tools = [
     new SerpAPI(process.env.SERPAPI_API_KEY, {
       location: "Austin,Texas,United States",
+      hl: "en",
+      gl: "us",
     }),
     new Calculator(),
   ];

diff --git a/examples/src/agents/load_from_hub.ts b/examples/src/agents/load_from_hub.ts
@@ -9,6 +9,8 @@ export const run = async () => {
   const tools = [
     new SerpAPI(process.env.SERPAPI_API_KEY, {
       location: "Austin,Texas,United States",
+      hl: "en",
+      gl: "us",
     }),
     new Calculator(),
   ];

diff --git a/examples/src/agents/mrkl.ts b/examples/src/agents/mrkl.ts
@@ -8,6 +8,8 @@ export const run = async () => {
   const tools = [
     new SerpAPI(process.env.SERPAPI_API_KEY, {
       location: "Austin,Texas,United States",
+      hl: "en",
+      gl: "us",
     }),
     new Calculator(),
   ];

diff --git a/examples/src/agents/mrkl_with_tracing.ts b/examples/src/agents/mrkl_with_tracing.ts
@@ -10,6 +10,8 @@ export const run = async () => {
   const tools = [
     new SerpAPI(process.env.SERPAPI_API_KEY, {
       location: "Austin,Texas,United States",
+      hl: "en",
+      gl: "us",
     }),
     new Calculator(),
   ];

diff --git a/examples/src/chat/agent.ts b/examples/src/chat/agent.ts
@@ -12,6 +12,8 @@ export const run = async () => {
   const tools = [
     new SerpAPI(process.env.SERPAPI_API_KEY, {
       location: "Austin,Texas,United States",
+      hl: "en",
+      gl: "us",
     }),
   ];
 

diff --git a/examples/src/chat/overview.ts b/examples/src/chat/overview.ts
@@ -128,6 +128,8 @@ export const run = async () => {
   const tools = [
     new SerpAPI(process.env.SERPAPI_API_KEY, {
       location: "Austin,Texas,United States",
+      hl: "en",
+      gl: "us",
     }),
   ];
   // Create the agent from the chat model and the tools

diff --git a/langchain/src/agents/tests/agent.int.test.ts b/langchain/src/agents/tests/agent.int.test.ts
@@ -9,7 +9,11 @@ import { initializeAgentExecutor } from "../initialize.js";
 test("Run agent from hub", async () => {
   const model = new OpenAI({ temperature: 0, modelName: "text-babbage-001" });
   const tools: Tool[] = [
-    new SerpAPI(undefined, { location: "Austin,Texas,United States" }),
+    new SerpAPI(undefined, {
+      location: "Austin,Texas,United States",
+      hl: "en",
+      gl: "us",
+    }),
     new Calculator(),
   ];
   const agent = await loadAgent(
@@ -31,7 +35,11 @@ test("Run agent from hub", async () => {
 test("Run agent locally", async () => {
   const model = new OpenAI({ temperature: 0, modelName: "text-babbage-001" });
   const tools = [
-    new SerpAPI(undefined, { location: "Austin,Texas,United States" }),
+    new SerpAPI(undefined, {
+      location: "Austin,Texas,United States",
+      hl: "en",
+      gl: "us",
+    }),
     new Calculator(),
   ];
 

diff --git a/langchain/src/callbacks/tests/langchain_tracer.int.test.ts b/langchain/src/callbacks/tests/langchain_tracer.int.test.ts
@@ -28,8 +28,10 @@ test.skip("Test Traced Agent with concurrency (skipped until we fix concurrency)
   process.env.LANGCHAIN_HANDLER = "langchain";
   const model = new OpenAI({ temperature: 0 });
   const tools = [
-    new SerpAPI(process.env.SERPAPI_API_KEY, {
+    new SerpAPI(undefined, {
       location: "Austin,Texas,United States",
+      hl: "en",
+      gl: "us",
     }),
     new Calculator(),
   ];

diff --git a/langchain/src/tools/serpapi.ts b/langchain/src/tools/serpapi.ts
@@ -5,6 +5,9 @@ import { Tool } from "./base.js";
  * when used in `jest` tests. Part of the issue seems to be that the `serpapi`
  * package imports a wasm module to use instead of native `fetch`, which we
  * don't want anyway.
+ *
+ * NOTE: you must provide location, gl and hl or your region and language will
+ * may not match your location, and will not be deterministic.
  */
 
 // Copied over from `serpapi` package
@@ -43,12 +46,8 @@ interface GoogleParameters extends BaseParameters {
   q: string;
   /**
    * Location
-   * Parameter defines from where you want the search to originate. Serpapi advises
-   * that if you do not provide a location, any location from around the world might
-   * be used including a different region and language. Location can be a canonical
-   * name (e.g., "Austin,Texas,United States") or the location id
-   * (e.g., "585069efee19ad271e9c9b36") If several locations match the location
-   * requested, we'll pick the most popular one. Head to the
+   * Parameter defines from where you want the search to originate. If several
+   * locations match the location requested, we'll pick the most popular one. Head to
    * [/locations.json API](https://serpapi.com/locations-api) if you need more
    * precise control. location and uule parameters can't be used together. Avoid
    * utilizing location when setting the location outside the U.S. when using Google