langchain.js
    Preparing search index...

    Class TavilySearchAPIRetriever

    A class for retrieving documents related to a given search term using the Tavily Search API.

    Hierarchy (View Summary)

    Index

    Constructors

    constructor

    Properties

    apiKey? excludeDomains? includeDomains? includeGeneratedAnswer includeImages includeRawContent k kwargs searchDepth

    Accessors

    lc_namespace

    Methods

    _getRelevantDocuments lc_name

    Constructors

    • Parameters

      • Optionalfields: any

      Returns TavilySearchAPIRetriever

    Properties

    apiKey?: string
    excludeDomains?: string[]
    includeDomains?: string[]
    includeGeneratedAnswer: boolean = false
    includeImages: boolean = false
    includeRawContent: boolean = false
    k: number = 10
    kwargs: Record<string, unknown> = {}
    searchDepth: string = "basic"

    Accessors

    • get lc_namespace(): string[]

      Returns string[]

    Methods

    _getRelevantDocuments

    • _getRelevantDocuments(query: string, _runManager?: any): Promise<Document[]>

      Parameters

      • query: string
      • Optional_runManager: any

      Returns Promise<Document[]>

    • Returns string

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Accessors
    Methods