Class TavilySearchAPIWrapper

A wrapper that encapsulates access to the Tavily Search API. Primarily used for testing.

Hierarchy

BaseTavilyAPIWrapper
- TavilySearchAPIWrapper

Index

Constructors

Properties

Methods

convertCamelToSnakeCase rawResults

Constructors

constructor

new TavilySearchAPIWrapper(fields): TavilySearchAPIWrapper
Constructs a new instance of the BaseTavilyAPIWrapper.
Parameters
- fields: {
  tavilyApiKey?: string;
  }
  The fields used to initialize the wrapper.
  - OptionaltavilyApiKey?: string
Returns TavilySearchAPIWrapper
Inherited from BaseTavilyAPIWrapper.constructor
- Defined in libs/langchain-tavily/src/utils.ts:282

Properties

`Optional`tavilyApiKey

tavilyApiKey?: string

Methods

`Protected`convertCamelToSnakeCase

convertCamelToSnakeCase(params): Record<string, unknown>
Converts camelCase keys to snake_case for API compatibility
Parameters
- params: Record<string, unknown>
  The parameters with camelCase keys
Returns Record<string, unknown>
The parameters with snake_case keys only
Inherited from BaseTavilyAPIWrapper.convertCamelToSnakeCase
- Defined in libs/langchain-tavily/src/utils.ts:298

rawResults

rawResults(params): Promise<TavilySearchResponseWithSimpleImages>
Performs a search using the Tavily Search API.
Parameters
- params: TavilySearchParamsWithSimpleImages
  The parameters for the search.
Returns Promise<TavilySearchResponseWithSimpleImages>
The raw response body from the Tavily Search API.
- Defined in libs/langchain-tavily/src/utils.ts:329
rawResults(params): Promise<TavilySearchResponseWithImageDescriptions>
Parameters
- params: TavilySearchParamsWithImageDescriptions
Returns Promise<TavilySearchResponseWithImageDescriptions>
- Defined in libs/langchain-tavily/src/utils.ts:333