Class TavilyCrawlAPIWrapper

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

Hierarchy

BaseTavilyAPIWrapper
- TavilyCrawlAPIWrapper

Index

Constructors

Properties

apiBaseUrl? tavilyApiKey?

Methods

convertCamelToSnakeCase rawResults

Constructors

constructor

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

Properties

`Optional`apiBaseUrl

apiBaseUrl?: string

`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:573

rawResults

rawResults(params): Promise<TavilyCrawlResponse>
Crawls a list of URLs using the Tavily Crawl API.
Parameters
- params: TavilyCrawlParams
  The parameters for the crawl. See TavilyCrawlParams.
Returns Promise<TavilyCrawlResponse>
The raw response body from the Tavily Crawl API. See TavilyCrawlResponse.
- Defined in libs/langchain-tavily/src/utils.ts:682