Package dev.langchain4j.adaptiverag

Record Class WebSearchTool

java.lang.Object
java.lang.Record
dev.langchain4j.adaptiverag.WebSearchTool
All Implemented Interfaces:
Function<String,List<dev.langchain4j.rag.content.Content>>
public record WebSearchTool(String tavilyApiKey) extends Record implements Function<String,List<dev.langchain4j.rag.content.Content>>
The `WebSearchTool` class provides a solution for performing web searches based on user queries. It implements the Function<String, List<Content>> interface to define how queries are processed and results are returned. The class utilizes an API key from Tavily to authenticate requests to their search engine.
Since:
1.0
Author:
Your Name (if applicable)

  • Constructor Summary

    Constructors
    Constructor
    Description
    WebSearchTool(String tavilyApiKey)
    Creates an instance of a WebSearchTool record class.

  • Method Summary

    Modifier and Type
    Method
    Description
    List<dev.langchain4j.rag.content.Content>
    apply(String query)
    Applies the query to a search engine and retrieves up to 3 results.
    final boolean
    equals(Object o)
    Indicates whether some other object is "equal to" this one.
    final int
    hashCode()
    Returns a hash code value for this object.
    String
    tavilyApiKey()
    Returns the value of the tavilyApiKey record component.
    final String
    toString()
    Returns a string representation of this record class.

    Methods inherited from class java.lang.Object

    clone, finalize, getClass, notify, notifyAll, wait, wait, wait

    Methods inherited from interface java.util.function.Function

    andThen, compose

  • Constructor Details

    • WebSearchTool

      public WebSearchTool(String tavilyApiKey)
      Creates an instance of a WebSearchTool record class.
      Parameters:
      tavilyApiKey - the value for the tavilyApiKey record component

  • Method Details

    • apply

      public List<dev.langchain4j.rag.content.Content> apply(String query)
      Applies the query to a search engine and retrieves up to 3 results.
      Specified by:
      apply in interface Function<String,List<dev.langchain4j.rag.content.Content>>
      Parameters:
      query - The search query to be executed.
      Returns:
      A list of content items retrieved from the searchengine.

    • toString

      public final String toString()
      Returns a string representation of this record class. The representation contains the name of the class, followed by the name and value of each of the record components.
      Specified by:
      toString in class Record
      Returns:
      a string representation of this object

    • hashCode

      public final int hashCode()
      Returns a hash code value for this object. The value is derived from the hash code of each of the record components.
      Specified by:
      hashCode in class Record
      Returns:
      a hash code value for this object

    • equals

      public final boolean equals(Object o)
      Indicates whether some other object is "equal to" this one. The objects are equal if the other object is of the same class and if all the record components are equal. All components in this record class are compared with Objects::equals(Object,Object).
      Specified by:
      equals in class Record
      Parameters:
      o - the object with which to compare
      Returns:
      true if this object is the same as the o argument; false otherwise.

    • tavilyApiKey

      public String tavilyApiKey()
      Returns the value of the tavilyApiKey record component.
      Returns:
      the value of the tavilyApiKey record component